Refactor caching and update dependencies

Updated Program.cs to use HybridCache and improved Swagger setup.
Refactored ChatService to simplify chat history management.
Updated SqlDatabaseVectorSearch.csproj to target net9.0 and
updated package references.
This commit is contained in:
Marco Minerva
2024-12-10 11:38:59 +01:00
parent 7989a1570f
commit 7e632892c7
3 changed files with 59 additions and 80 deletions
+28 -55
View File
@@ -1,14 +1,13 @@
using System.ComponentModel;
using Microsoft.AspNetCore.Http.HttpResults;
using Microsoft.EntityFrameworkCore;
using Microsoft.OpenApi.Models;
using Microsoft.SemanticKernel;
using MinimalHelpers.OpenApi;
using SqlDatabaseVectorSearch.DataAccessLayer;
using SqlDatabaseVectorSearch.Models;
using SqlDatabaseVectorSearch.Services;
using SqlDatabaseVectorSearch.Settings;
using TinyHelpers.AspNetCore.Extensions;
using TinyHelpers.AspNetCore.Swagger;
using TinyHelpers.AspNetCore.OpenApi;
var builder = WebApplication.CreateBuilder(args);
builder.Configuration.AddJsonFile("appsettings.local.json", optional: true, reloadOnChange: true);
@@ -22,13 +21,18 @@ builder.Services.AddSingleton(TimeProvider.System);
builder.Services.AddSqlServer<ApplicationDbContext>(builder.Configuration.GetConnectionString("SqlConnection"), options =>
{
options.UseVectorSearch();
options.EnableRetryOnFailure();
}, options =>
{
options.UseQueryTrackingBehavior(QueryTrackingBehavior.NoTracking);
});
builder.Services.AddMemoryCache();
builder.Services.AddHybridCache(options =>
{
options.DefaultEntryOptions = new()
{
LocalCacheExpiration = appSettings.MessageExpiration
};
});
// Semantic Kernel is used to generate embeddings and to reformulate questions taking into account all the previous interactions,
// so that embeddings themselves can be generated more accurately.
@@ -39,11 +43,8 @@ builder.Services.AddKernel()
builder.Services.AddSingleton<ChatService>();
builder.Services.AddScoped<VectorSearchService>();
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen(options =>
builder.Services.AddOpenApi(options =>
{
options.SwaggerDoc("v1", new OpenApiInfo { Title = "SQL Database Vector Search API", Version = "v1" });
options.AddDefaultResponse();
});
@@ -60,11 +61,11 @@ app.UseStatusCodePages();
if (app.Environment.IsDevelopment())
{
app.UseSwagger();
app.MapOpenApi();
app.UseSwaggerUI(options =>
{
options.RoutePrefix = string.Empty;
options.SwaggerEndpoint("/swagger/v1/swagger.json", "SQL Database Vector Search API v1");
options.SwaggerEndpoint("/openapi/v1.json", builder.Environment.ApplicationName);
});
}
@@ -75,24 +76,15 @@ documentsApiGroup.MapGet(string.Empty, async (VectorSearchService vectorSearchSe
var documents = await vectorSearchService.GetDocumentsAsync();
return TypedResults.Ok(documents);
})
.WithOpenApi(operation =>
{
operation.Summary = "Gets the list of documents";
return operation;
});
.WithSummary("Gets the list of documents");
documentsApiGroup.MapGet("{documentId:guid}/chunks", async (Guid documentId, VectorSearchService vectorSearchService) =>
{
var documents = await vectorSearchService.GetDocumentChunksAsync(documentId);
return TypedResults.Ok(documents);
})
.WithOpenApi(operation =>
{
operation.Summary = "Gets the list of chunks of a given document";
operation.Description = "The list does not contain embedding. Use '/api/documents/{documentId}/chunks/{documentChunkId}' to get the embedding for a given chunk.";
return operation;
});
.WithSummary("Gets the list of chunks of a given document")
.WithDescription("The list does not contain embedding. Use '/api/documents/{documentId}/chunks/{documentChunkId}' to get the embedding for a given chunk.");
documentsApiGroup.MapGet("{documentId:guid}/chunks/{documentChunkId:guid}", async Task<Results<Ok<DocumentChunk>, NotFound>> (Guid documentId, Guid documentChunkId, VectorSearchService vectorSearchService) =>
{
@@ -104,13 +96,11 @@ documentsApiGroup.MapGet("{documentId:guid}/chunks/{documentChunkId:guid}", asyn
return TypedResults.Ok(chunk);
})
.WithOpenApi(operation =>
{
operation.Summary = "Gets the details of a given chunk, includings its embedding";
return operation;
});
.ProducesProblem(StatusCodes.Status404NotFound)
.WithSummary("Gets the details of a given chunk, includings its embedding");
documentsApiGroup.MapPost(string.Empty, async (IFormFile file, VectorSearchService vectorSearchService, Guid? documentId = null) =>
documentsApiGroup.MapPost(string.Empty, async (IFormFile file, VectorSearchService vectorSearchService,
[Description("The unique identifier of the document. If not provided, a new one will be generated. If you specify an existing documentId, the corresponding document will be overwritten.")] Guid? documentId = null) =>
{
using var stream = file.OpenReadStream();
documentId = await vectorSearchService.ImportAsync(stream, file.FileName, documentId);
@@ -118,43 +108,26 @@ documentsApiGroup.MapPost(string.Empty, async (IFormFile file, VectorSearchServi
return TypedResults.Ok(new UploadDocumentResponse(documentId.Value));
})
.DisableAntiforgery()
.WithOpenApi(operation =>
{
operation.Summary = "Uploads a document";
operation.Description = "Uploads a document to SQL Database and saves its embedding using the new native Vector type. The document will be indexed and used to answer questions. Currently, only PDF files are supported.";
operation.Parameter("documentId").Description = "The unique identifier of the document. If not provided, a new one will be generated. If you specify an existing documentId, the corresponding document will be overwritten.";
return operation;
});
.ProducesProblem(StatusCodes.Status400BadRequest)
.WithSummary("Uploads a document")
.WithDescription("Uploads a document to SQL Database and saves its embedding using the new native Vector type. The document will be indexed and used to answer questions. Currently, only PDF files are supported.");
documentsApiGroup.MapDelete("{documentId:guid}", async (Guid documentId, VectorSearchService vectorSearchService) =>
{
await vectorSearchService.DeleteDocumentAsync(documentId);
return TypedResults.NoContent();
})
.WithOpenApi(operation =>
{
operation.Summary = "Deletes a document";
operation.Description = "This endpoint deletes the document and all its chunks.";
.WithSummary("Deletes a document")
.WithDescription("This endpoint deletes the document and all its chunks.");
return operation;
});
app.MapPost("/api/ask", async (Question question, VectorSearchService vectorSearchService, bool reformulate = true) =>
app.MapPost("/api/ask", async (Question question, VectorSearchService vectorSearchService,
[Description("If true, the question will be reformulated taking into account the context of the chat identified by the given ConversationId.")] bool reformulate = true) =>
{
var response = await vectorSearchService.AskQuestionAsync(question, reformulate);
return TypedResults.Ok(response);
})
.WithOpenApi(operation =>
{
operation.Summary = "Asks a question";
operation.Description = "The question will be reformulated taking into account the context of the chat identified by the given ConversationId.";
operation.Parameter("reformulate").Description = "If true, the question will be reformulated taking into account the context of the chat identified by the given ConversationId.";
return operation;
})
.WithSummary("Asks a question")
.WithDescription("The question will be reformulated taking into account the context of the chat identified by the given ConversationId.")
.WithTags("Ask");
app.Run();
+26 -20
View File
@@ -1,18 +1,14 @@
using System.Text;
using Microsoft.Extensions.Caching.Memory;
using Microsoft.Extensions.Options;
using Microsoft.Extensions.Caching.Hybrid;
using Microsoft.SemanticKernel.ChatCompletion;
using SqlDatabaseVectorSearch.Settings;
namespace SqlDatabaseVectorSearch.Services;
public class ChatService(IMemoryCache cache, IChatCompletionService chatCompletionService, IOptions<AppSettings> appSettingsOptions)
public class ChatService(IChatCompletionService chatCompletionService, HybridCache cache)
{
private readonly AppSettings appSettings = appSettingsOptions.Value;
public async Task<string> CreateQuestionAsync(Guid conversationId, string question)
{
var chat = new ChatHistory(cache.Get<ChatHistory?>(conversationId) ?? []);
var chat = await GetChatHistoryAsync(conversationId);
var embeddingQuestion = $"""
Reformulate the following question taking into account the context of the chat to perform embeddings search:
@@ -67,23 +63,33 @@ public class ChatService(IMemoryCache cache, IChatCompletionService chatCompleti
var answer = await chatCompletionService.GetChatMessageContentAsync(chat)!;
// Add question and answer to the chat history.
var history = new ChatHistory(cache.Get<ChatHistory?>(conversationId) ?? []);
history.AddUserMessage(question);
history.AddAssistantMessage(answer.Content!);
await UpdateCacheAsync(conversationId, history);
await SetChatHistoryAsync(conversationId, question, answer.Content!);
return answer.Content!;
}
private Task UpdateCacheAsync(Guid conversationId, ChatHistory chat)
{
if (chat.Count > appSettings.MessageLimit)
{
chat = new ChatHistory(chat.TakeLast(appSettings.MessageLimit));
}
private async Task UpdateCacheAsync(Guid conversationId, ChatHistory chat)
=> await cache.SetAsync(conversationId.ToString(), chat);
cache.Set(conversationId, chat, appSettings.MessageExpiration);
return Task.CompletedTask;
private async Task<ChatHistory> GetChatHistoryAsync(Guid conversationId)
{
var historyCache = await cache.GetOrCreateAsync(conversationId.ToString(),
(cancellationToken) =>
{
return ValueTask.FromResult<ChatHistory>([]);
});
var chat = new ChatHistory(historyCache);
return chat;
}
private async Task SetChatHistoryAsync(Guid conversationId, string question, string answer)
{
var history = await GetChatHistoryAsync(conversationId);
history.AddUserMessage(question);
history.AddAssistantMessage(answer);
await UpdateCacheAsync(conversationId, history);
}
}
@@ -4,7 +4,7 @@
<TargetFramework>net9.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
<NoWarn>$(NoWarn);SKEXP0001;SKEXP0010;SKEXP0050;</NoWarn>
<NoWarn>$(NoWarn);SKEXP0001;SKEXP0010;SKEXP0050;EXTEXP0018</NoWarn>
</PropertyGroup>
<ItemGroup>
@@ -12,12 +12,12 @@
<PackageReference Include="EntityFrameworkCore.Exceptions.SqlServer" Version="8.1.3" />
<PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="9.0.0" />
<PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" Version="[8.0.11,9.0.0)" />
<PackageReference Include="Microsoft.SemanticKernel" Version="1.31.0" />
<PackageReference Include="MinimalHelpers.OpenApi" Version="2.0.17" />
<PackageReference Include="Microsoft.Extensions.Caching.Hybrid" Version="9.0.0-preview.9.24556.5" />
<PackageReference Include="Microsoft.SemanticKernel" Version="1.32.0" />
<PackageReference Include="MinimalHelpers.OpenApi" Version="2.1.2" />
<PackageReference Include="PdfPig" Version="0.1.9" />
<PackageReference Include="Swashbuckle.AspNetCore" Version="7.1.0" />
<PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="7.1.0" />
<PackageReference Include="TinyHelpers.AspNetCore" Version="4.0.5" />
<PackageReference Include="TinyHelpers.AspNetCore.Swashbuckle" Version="4.0.5" />
</ItemGroup>
</Project>