.Net: Add PostgresVectorStore Memory connector.

dotnet/SK-dotnet.sln

@@ -407,6 +407,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AotCompatibility", "samples
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "SemanticKernel.AotTests", "src\SemanticKernel.AotTests\SemanticKernel.AotTests.csproj", "{39EAB599-742F-417D-AF80-95F90376BB18}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Connectors.Postgres.UnitTests", "src\Connectors\Connectors.Postgres.UnitTests\Connectors.Postgres.UnitTests.csproj", "{232E1153-6366-4175-A982-D66B30AAD610}"
+EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Process.Utilities.UnitTests", "src\Experimental\Process.Utilities.UnitTests\Process.Utilities.UnitTests.csproj", "{DAC54048-A39A-4739-8307-EA5A291F2EA0}"
 EndProject
 Global
@@ -1046,6 +1048,12 @@ Global
 		{6F591D05-5F7F-4211-9042-42D8BCE60415}.Publish|Any CPU.Build.0 = Debug|Any CPU
 		{6F591D05-5F7F-4211-9042-42D8BCE60415}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{6F591D05-5F7F-4211-9042-42D8BCE60415}.Release|Any CPU.Build.0 = Release|Any CPU
+		{232E1153-6366-4175-A982-D66B30AAD610}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{232E1153-6366-4175-A982-D66B30AAD610}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{232E1153-6366-4175-A982-D66B30AAD610}.Publish|Any CPU.ActiveCfg = Debug|Any CPU
+		{232E1153-6366-4175-A982-D66B30AAD610}.Publish|Any CPU.Build.0 = Debug|Any CPU
+		{232E1153-6366-4175-A982-D66B30AAD610}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{232E1153-6366-4175-A982-D66B30AAD610}.Release|Any CPU.Build.0 = Release|Any CPU
 		{E82B640C-1704-430D-8D71-FD8ED3695468}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{E82B640C-1704-430D-8D71-FD8ED3695468}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{E82B640C-1704-430D-8D71-FD8ED3695468}.Publish|Any CPU.ActiveCfg = Debug|Any CPU
@@ -1216,6 +1224,7 @@ Global
 		{E82B640C-1704-430D-8D71-FD8ED3695468} = {5A7028A7-4DDF-4E4F-84A9-37CE8F8D7E89}
 		{6ECFDF04-2237-4A85-B114-DAA34923E9E6} = {5D4C0700-BBB5-418F-A7B2-F392B9A18263}
 		{39EAB599-742F-417D-AF80-95F90376BB18} = {831DDCA2-7D2C-4C31-80DB-6BDB3E1F7AE0}
+		{232E1153-6366-4175-A982-D66B30AAD610} = {0247C2C9-86C3-45BA-8873-28B0948EDC0C}
 		{DAC54048-A39A-4739-8307-EA5A291F2EA0} = {0D8C6358-5DAA-4EA6-A924-C268A9A21BC9}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution

dotnet/samples/Concepts/Concepts.csproj

@@ -102,6 +102,9 @@
   </ItemGroup>
 
   <ItemGroup>
+    <None Update="appsettings.Development.json">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </None>
     <None Include="Resources\Plugins\ApiManifestPlugins\**\apimanifest.json">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>

dotnet/samples/Concepts/Memory/VectorStoreFixtures/VectorStoreInfra.cs

@@ -10,6 +10,51 @@ namespace Memory.VectorStoreFixtures;
 /// </summary>
 internal static class VectorStoreInfra
 {
+    /// <summary>
+    /// Setup the postgres pgvector container by pulling the image and running it.
+    /// </summary>
+    /// <param name="client">The docker client to create the container with.</param>
+    /// <returns>The id of the container.</returns>
+    public static async Task<string> SetupPostgresContainerAsync(DockerClient client)
+    {
+        await client.Images.CreateImageAsync(
+            new ImagesCreateParameters
+            {
+                FromImage = "pgvector/pgvector",
+                Tag = "pg16",
+            },
+            null,
+            new Progress<JSONMessage>());
+
+        var container = await client.Containers.CreateContainerAsync(new CreateContainerParameters()
+        {
+            Image = "pgvector/pgvector:pg16",
+            HostConfig = new HostConfig()
+            {
+                PortBindings = new Dictionary<string, IList<PortBinding>>
+                {
+                    {"5432", new List<PortBinding> {new() {HostPort = "5432" } }},
+                },
+                PublishAllPorts = true
+            },
+            ExposedPorts = new Dictionary<string, EmptyStruct>
+            {
+               { "5432", default },
+            },
+            Env = new List<string>
+            {
+                "POSTGRES_USER=postgres",
+                "POSTGRES_PASSWORD=example",
+            },
+        });
+
+        await client.Containers.StartContainerAsync(
+            container.ID,
+            new ContainerStartParameters());
+
+        return container.ID;
+    }
+
     /// <summary>
     /// Setup the qdrant container by pulling the image and running it.
     /// </summary>

dotnet/samples/Concepts/Memory/VectorStoreFixtures/VectorStorePostgresContainerFixture.cs

@@ -0,0 +1,67 @@
+// Copyright (c) Microsoft. All rights reserved.
+
+using Docker.DotNet;
+using Npgsql;
+
+namespace Memory.VectorStoreFixtures;
+
+/// <summary>
+/// Fixture to use for creating a Postgres container before tests and delete it after tests.
+/// </summary>
+public class VectorStorePostgresContainerFixture : IAsyncLifetime
+{
+    private DockerClient? _dockerClient;
+    private string? _postgresContainerId;
+
+    public async Task InitializeAsync()
+    {
+    }
+
+    public async Task ManualInitializeAsync()
+    {
+        if (this._postgresContainerId == null)
+        {
+            // Connect to docker and start the docker container.
+            using var dockerClientConfiguration = new DockerClientConfiguration();
+            this._dockerClient = dockerClientConfiguration.CreateClient();
+            this._postgresContainerId = await VectorStoreInfra.SetupPostgresContainerAsync(this._dockerClient);
+
+            // Delay until the Postgres server is ready.
+            var connectionString = "Host=localhost;Port=5432;Username=postgres;Password=example;Database=postgres;";
+            var succeeded = false;
+            var attemptCount = 0;
+            while (!succeeded && attemptCount++ < 10)
+            {
+                try
+                {
+                    NpgsqlDataSourceBuilder dataSourceBuilder = new(connectionString);
+                    dataSourceBuilder.UseVector();
+                    using var dataSource = dataSourceBuilder.Build();
+                    NpgsqlConnection connection = await dataSource.OpenConnectionAsync().ConfigureAwait(false);
+
+                    await using (connection)
+                    {
+                        // Create extension vector if it doesn't exist
+                        await using (NpgsqlCommand command = new("CREATE EXTENSION IF NOT EXISTS vector", connection))
+                        {
+                            await command.ExecuteNonQueryAsync();
+                        }
+                    }
+                }
+                catch (Exception)
+                {
+                    await Task.Delay(1000);
+                }
+            }
+        }
+    }
+
+    public async Task DisposeAsync()
+    {
+        if (this._dockerClient != null && this._postgresContainerId != null)
+        {
+            // Delete docker container.
+            await VectorStoreInfra.DeleteContainerAsync(this._dockerClient, this._postgresContainerId);
+        }
+    }
+}

dotnet/samples/Concepts/Memory/VectorStore_VectorSearch_MultiStore_Postgres.cs

@@ -0,0 +1,90 @@
+// Copyright (c) Microsoft. All rights reserved.
+
+using Azure.Identity;
+using Memory.VectorStoreFixtures;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.SemanticKernel;
+using Microsoft.SemanticKernel.Connectors.AzureOpenAI;
+using Microsoft.SemanticKernel.Connectors.Postgres;
+using Npgsql;
+
+namespace Memory;
+
+/// <summary>
+/// An example showing how to use common code, that can work with any vector database, with a Postgres database.
+/// The common code is in the <see cref="VectorStore_VectorSearch_MultiStore_Common"/> class.
+/// The common code ingests data into the vector store and then searches over that data.
+/// This example is part of a set of examples each showing a different vector database.
+///
+/// For other databases, see the following classes:
+/// <para><see cref="VectorStore_VectorSearch_MultiStore_AzureAISearch"/></para>
+/// <para><see cref="VectorStore_VectorSearch_MultiStore_Redis"/></para>
+/// <para><see cref="VectorStore_VectorSearch_MultiStore_InMemory"/></para>
+///
+/// To run this sample, you need a local instance of Docker running, since the associated fixture will try and start a Postgres container in the local docker instance.
+/// </summary>
+public class VectorStore_VectorSearch_MultiStore_Postgres(ITestOutputHelper output, VectorStorePostgresContainerFixture PostgresFixture) : BaseTest(output), IClassFixture<VectorStorePostgresContainerFixture>
+{
+    /// <summary>
+    /// The connection string to the Postgres database hosted in the docker container.
+    /// </summary>
+    private const string ConnectionString = "Host=localhost;Port=5432;Username=postgres;Password=example;Database=postgres;";
+
+    [Fact]
+    public async Task ExampleWithDIAsync()
+    {
+        // Use the kernel for DI purposes.
+        var kernelBuilder = Kernel
+            .CreateBuilder();
+
+        // Register an embedding generation service with the DI container.
+        kernelBuilder.AddAzureOpenAITextEmbeddingGeneration(
+            deploymentName: TestConfiguration.AzureOpenAIEmbeddings.DeploymentName,
+            endpoint: TestConfiguration.AzureOpenAIEmbeddings.Endpoint,
+            credential: new AzureCliCredential());
+
+        // Initialize the Postgres docker container via the fixtures and register the Postgres VectorStore.
+        await PostgresFixture.ManualInitializeAsync();
+        kernelBuilder.Services.AddPostgresVectorStore(ConnectionString);
+
+        // Register the test output helper common processor with the DI container.
+        kernelBuilder.Services.AddSingleton<ITestOutputHelper>(this.Output);
+        kernelBuilder.Services.AddTransient<VectorStore_VectorSearch_MultiStore_Common>();
+
+        // Build the kernel.
+        var kernel = kernelBuilder.Build();
+
+        // Build a common processor object using the DI container.
+        var processor = kernel.GetRequiredService<VectorStore_VectorSearch_MultiStore_Common>();
+
+        // Run the process and pass a key generator function to it, to generate unique record keys.
+        // The key generator function is required, since different vector stores may require different key types.
+        // E.g. Postgres supports Guid and ulong keys, but others may support strings only.
+        await processor.IngestDataAndSearchAsync("skglossaryWithDI", () => Guid.NewGuid());
+    }
+
+    [Fact]
+    public async Task ExampleWithoutDIAsync()
+    {
+        // Create an embedding generation service.
+        var textEmbeddingGenerationService = new AzureOpenAITextEmbeddingGenerationService(
+                TestConfiguration.AzureOpenAIEmbeddings.DeploymentName,
+                TestConfiguration.AzureOpenAIEmbeddings.Endpoint,
+                new AzureCliCredential());
+
+        // Initialize the Postgres docker container via the fixtures and construct the Postgres VectorStore.
+        await PostgresFixture.ManualInitializeAsync();
+        var dataSourceBuilder = new NpgsqlDataSourceBuilder(ConnectionString);
+        dataSourceBuilder.UseVector();
+        await using var dataSource = dataSourceBuilder.Build();
+        var vectorStore = new PostgresVectorStore(dataSource);
+
+        // Create the common processor that works for any vector store.
+        var processor = new VectorStore_VectorSearch_MultiStore_Common(vectorStore, textEmbeddingGenerationService, this.Output);
+
+        // Run the process and pass a key generator function to it, to generate unique record keys.
+        // The key generator function is required, since different vector stores may require different key types.
+        // E.g. Postgres supports Guid and ulong keys, but others may support strings only.
+        await processor.IngestDataAndSearchAsync("skglossaryWithoutDI", () => Guid.NewGuid());
+    }
+}

dotnet/samples/Concepts/README.md

@@ -204,3 +204,88 @@ dotnet test -l "console;verbosity=detailed" --filter "FullyQualifiedName=ChatCom
 ### TextToImage - Using [`TextToImage`](https://github.com/microsoft/semantic-kernel/blob/main/dotnet/src/SemanticKernel.Abstractions/AI/TextToImage/ITextToImageService.cs) services to generate images
 
 - [OpenAI_TextToImage](https://github.com/microsoft/semantic-kernel/blob/main/dotnet/samples/Concepts/TextToImage/OpenAI_TextToImageDalle3.cs)
+
+## Configuration
+
+### Option 1: Use Secret Manager
+
+Concept samples will require secrets and credentials, to access OpenAI, Azure OpenAI,
+Bing and other resources. 
+
+We suggest using .NET [Secret Manager](https://learn.microsoft.com/en-us/aspnet/core/security/app-secrets)
+to avoid the risk of leaking secrets into the repository, branches and pull requests.
+You can also use environment variables if you prefer.
+
+To set your secrets with Secret Manager:
+
+```
+cd dotnet/src/samples/Concepts
+
+dotnet user-secrets init
+
+dotnet user-secrets set "OpenAI:ServiceId" "gpt-3.5-turbo-instruct"
+dotnet user-secrets set "OpenAI:ModelId" "gpt-3.5-turbo-instruct"
+dotnet user-secrets set "OpenAI:ChatModelId" "gpt-4"
+dotnet user-secrets set "OpenAI:ApiKey" "..."
+
+...
+```
+
+### Option 2: Use Configuration File
+1. Create a `appsettings.Development.json` file next to the `Concepts.csproj` file. This file will be ignored by git,
+   the content will not end up in pull requests, so it's safe for personal settings. Keep the file safe.
+2. Edit `appsettings.Development.json` and set the appropriate configuration for the samples you are running.
+
+For example:
+
+```json
+{
+  "OpenAI": {
+    "ServiceId": "gpt-3.5-turbo-instruct",
+    "ModelId": "gpt-3.5-turbo-instruct",
+    "ChatModelId": "gpt-4",
+    "ApiKey": "sk-...."
+  },
+  "AzureOpenAI": {
+    "ServiceId": "azure-gpt-35-turbo-instruct",
+    "DeploymentName": "gpt-35-turbo-instruct",
+    "ChatDeploymentName": "gpt-4",
+    "Endpoint": "https://contoso.openai.azure.com/",
+    "ApiKey": "...."
+  },
+  // etc.
+}
+```
+
+### Option 3: Use Environment Variables
+You may also set the settings in your environment variables. The environment variables will override the settings in the `appsettings.Development.json` file.
+
+When setting environment variables, use a double underscore (i.e. "\_\_") to delineate between parent and child properties. For example:
+
+- bash:
+
+  ```bash
+  export OpenAI__ApiKey="sk-...."
+  export AzureOpenAI__ApiKey="...."
+  export AzureOpenAI__DeploymentName="gpt-35-turbo-instruct"
+  export AzureOpenAI__ChatDeploymentName="gpt-4"
+  export AzureOpenAIEmbeddings__DeploymentName="azure-text-embedding-ada-002"
+  export AzureOpenAI__Endpoint="https://contoso.openai.azure.com/"
+  export HuggingFace__ApiKey="...."
+  export Bing__ApiKey="...."
+  export Postgres__ConnectionString="...."
+  ```
+
+- PowerShell:
+
+  ```ps
+  $env:OpenAI__ApiKey = "sk-...."
+  $env:AzureOpenAI__ApiKey = "...."
+  $env:AzureOpenAI__DeploymentName = "gpt-35-turbo-instruct"
+  $env:AzureOpenAI__ChatDeploymentName = "gpt-4"
+  $env:AzureOpenAIEmbeddings__DeploymentName = "azure-text-embedding-ada-002"
+  $env:AzureOpenAI__Endpoint = "https://contoso.openai.azure.com/"
+  $env:HuggingFace__ApiKey = "...."
+  $env:Bing__ApiKey = "...."
+  $env:Postgres__ConnectionString = "...."
+  ```

dotnet/src/Connectors/Connectors.Memory.Postgres/Connectors.Memory.Postgres.csproj

@@ -27,4 +27,9 @@
     <ProjectReference Include="..\..\SemanticKernel.Core\SemanticKernel.Core.csproj" />
   </ItemGroup>
 
+  <ItemGroup>
+    <InternalsVisibleTo Include="SemanticKernel.Connectors.Postgres.UnitTests" />
+    <InternalsVisibleTo Include="DynamicProxyGenAssembly2" />
+  </ItemGroup>
+
 </Project>

dotnet/src/Connectors/Connectors.Memory.Postgres/IPostgresDbClient.cs

@@ -11,6 +11,11 @@ namespace Microsoft.SemanticKernel.Connectors.Postgres;
 /// <summary>
 /// Interface for client managing postgres database operations.
 /// </summary>
+/// <remarks>
+/// This interface is used with the PostgresMemoryStore, which is being deprecated.
+/// Use the <see cref="IPostgresVectorStoreDbClient"/> interface with the PostgresVectorStore
+/// and related classes instead.
+/// </remarks>
 public interface IPostgresDbClient
 {
     /// <summary>