-
Notifications
You must be signed in to change notification settings - Fork 3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Re-implementing the Postgres memory store (#1735)
### Motivation and Context <!-- Thank you for your contribution to the semantic-kernel repo! Please help reviewers and future users, providing the following information: 1. Why is this change required? 2. What problem does it solve? 3. What scenario does it contribute to? 4. If it fixes an open issue, please link to the issue here. --> Reimplement Postgres in-memory storage based on the discussion in #1338. ### Description <!-- Describe your changes, the overall approach, the underlying design. These notes will help understanding how your code works. Thanks! --> - Re-implementing the Postgres memory store, mapping between SK collection to Postgres table. - PostgresMemoryStore no longer implements `IDisposable` pattern. - No longer execute the enable pgvector extension statement, add it to README.md to be executed by the user. It only needs to be executed once in the database, and the extension may be enabled differently for different hosting methods. ### Contribution Checklist <!-- Before submitting this PR, please make sure: --> - [x] The code builds clean without any errors or warnings - [x] The PR follows SK Contribution Guidelines (https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md) - [x] The code follows the .NET coding conventions (https://learn.microsoft.com/dotnet/csharp/fundamentals/coding-style/coding-conventions) verified with `dotnet format` - [x] All unit tests pass, and I have added new tests where possible - [x] I didn't break anyone 😄 --------- Co-authored-by: Dmytro Struk <[email protected]>
- Loading branch information
1 parent
537bc49
commit 07aa6a7
Showing
12 changed files
with
1,052 additions
and
571 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
88 changes: 88 additions & 0 deletions
88
dotnet/src/Connectors/Connectors.Memory.Postgres/IPostgresDbClient.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,88 @@ | ||
// Copyright (c) Microsoft. All rights reserved. | ||
|
||
using System.Collections.Generic; | ||
using System.Threading; | ||
using System.Threading.Tasks; | ||
using Pgvector; | ||
|
||
namespace Microsoft.SemanticKernel.Connectors.Memory.Postgres; | ||
|
||
/// <summary> | ||
/// Interface for client managing postgres database operations. | ||
/// </summary> | ||
public interface IPostgresDbClient | ||
{ | ||
/// <summary> | ||
/// Check if a collection exists. | ||
/// </summary> | ||
/// <param name="collectionName">The name assigned to a collection of entries.</param> | ||
/// <param name="cancellationToken">The <see cref="CancellationToken"/> to monitor for cancellation requests. The default is <see cref="CancellationToken.None"/>.</param> | ||
/// <returns></returns> | ||
Task<bool> DoesCollectionExistsAsync(string collectionName, CancellationToken cancellationToken = default); | ||
|
||
/// <summary> | ||
/// Create a collection. | ||
/// </summary> | ||
/// <param name="collectionName">The name assigned to a collection of entries.</param> | ||
/// <param name="cancellationToken">The <see cref="CancellationToken"/> to monitor for cancellation requests. The default is <see cref="CancellationToken.None"/>.</param> | ||
/// <returns></returns> | ||
Task CreateCollectionAsync(string collectionName, CancellationToken cancellationToken = default); | ||
|
||
/// <summary> | ||
/// Get all collections. | ||
/// </summary> | ||
/// <param name="cancellationToken">The <see cref="CancellationToken"/> to monitor for cancellation requests. The default is <see cref="CancellationToken.None"/>.</param> | ||
/// <returns></returns> | ||
IAsyncEnumerable<string> GetCollectionsAsync(CancellationToken cancellationToken = default); | ||
|
||
/// <summary> | ||
/// Delete a collection. | ||
/// </summary> | ||
/// <param name="collectionName">The name assigned to a collection of entries.</param> | ||
/// <param name="cancellationToken">The <see cref="CancellationToken"/> to monitor for cancellation requests. The default is <see cref="CancellationToken.None"/>.</param> | ||
/// <returns></returns> | ||
Task DeleteCollectionAsync(string collectionName, CancellationToken cancellationToken = default); | ||
|
||
/// <summary> | ||
/// Upsert entry into a collection. | ||
/// </summary> | ||
/// <param name="collectionName">The name assigned to a collection of entries.</param> | ||
/// <param name="key">The key of the entry to upsert.</param> | ||
/// <param name="metadata">The metadata of the entry.</param> | ||
/// <param name="embedding">The embedding of the entry.</param> | ||
/// <param name="timestamp">The timestamp of the entry</param> | ||
/// <param name="cancellationToken">The <see cref="CancellationToken"/> to monitor for cancellation requests. The default is <see cref="CancellationToken.None"/>.</param> | ||
/// <returns></returns> | ||
Task UpsertAsync(string collectionName, string key, string? metadata, Vector? embedding, long? timestamp, CancellationToken cancellationToken = default); | ||
|
||
/// <summary> | ||
/// Gets the nearest matches to the <see cref="Vector"/>. | ||
/// </summary> | ||
/// <param name="collectionName">The name assigned to a collection of entries.</param> | ||
/// <param name="embeddingFilter">The <see cref="Vector"/> to compare the collection's embeddings with.</param> | ||
/// <param name="limit">The maximum number of similarity results to return.</param> | ||
/// <param name="minRelevanceScore">The minimum relevance threshold for returned results.</param> | ||
/// <param name="withEmbeddings">If true, the embeddings will be returned in the entries.</param> | ||
/// <param name="cancellationToken">The <see cref="CancellationToken"/> to monitor for cancellation requests. The default is <see cref="CancellationToken.None"/>.</param> | ||
/// <returns></returns> | ||
IAsyncEnumerable<(PostgresMemoryEntry, double)> GetNearestMatchesAsync(string collectionName, Vector embeddingFilter, int limit, double minRelevanceScore = 0, bool withEmbeddings = false, CancellationToken cancellationToken = default); | ||
|
||
/// <summary> | ||
/// Read a entry by its key. | ||
/// </summary> | ||
/// <param name="collectionName">The name assigned to a collection of entries.</param> | ||
/// <param name="key">The key of the entry to read.</param> | ||
/// <param name="withEmbeddings">If true, the embeddings will be returned in the entries.</param> | ||
/// <param name="cancellationToken">The <see cref="CancellationToken"/> to monitor for cancellation requests. The default is <see cref="CancellationToken.None"/>.</param> | ||
/// <returns></returns> | ||
Task<PostgresMemoryEntry?> ReadAsync(string collectionName, string key, bool withEmbeddings = false, CancellationToken cancellationToken = default); | ||
|
||
/// <summary> | ||
/// Delete a entry by its key. | ||
/// </summary> | ||
/// <param name="collectionName">The name assigned to a collection of entries.</param> | ||
/// <param name="key">The key of the entry to delete.</param> | ||
/// <param name="cancellationToken">The <see cref="CancellationToken"/> to monitor for cancellation requests. The default is <see cref="CancellationToken.None"/>.</param> | ||
/// <returns></returns> | ||
Task DeleteAsync(string collectionName, string key, CancellationToken cancellationToken = default); | ||
} |
Oops, something went wrong.