SemanticKernelPlugin - Return citation information

[malv007]

Would it make sense for methods SearchAsync and AskAsync in the MemoryPlugin class (SemanticKernelPlugin) to return a KernelSearchResults object instead of a string? I think this would allow for Semantic Kernel to provide citation information with the search results.

[dluc]

hi @malv007 the response includes sources, there are examples and docs in the repo showing what the service returns.

[malv007]

Thanks so much for the reply! When I tried the MemoryPlugin didn't seem to return the sources, I think it is just returning the text from the partitions.

kernel-memory/clients/dotnet/SemanticKernelPlugin/MemoryPlugin.cs

Line 380 in b67dfe7

return limit == 1

and if the MemoryPlugin should return something like this instead, so Semantic Kernel can pick up the sources.

      var searchResult = new KernelSearchResults<TextSearchResult>(
        result.Results.Select(x => new TextSearchResult(x.Partitions.First().Text) { Name = x.SourceName, Link = x.Link, Value = x.Partitions.First().Text }).ToAsyncEnumerable(),
        result.Results.Count,
        new Dictionary<string, object>() { { "query", result.Query } }
        );

[malv007]

I tried what I was proposing and it didn't work :( The citations get generated in Kernel Memory, but then Semantic Kernel isn't able to interpret them. Right now we are using our Kernel Memory as a Plugin in Semantic Kernel.

I have gone through all the examples, but I couldn't find one that passes the citations to Semantic Kernel, in particular to the AzureOpenAIChatCompletionService (IChatCompletionService). I would like for the citations generated in Kernel Memory to be passed to the context in the IChatCompletionService, but I am not sure this is possible.

      var message = chatMessageContent.InnerContent as OpenAI.Chat.ChatCompletion;
      var messageContext = message.GetMessageContext();
      var citations = messageContext.Citations;

Is there a way this can be achieved? Is there a better approach for this?

[malv007]

In case it helps anybody else, we managed to get this to work with help from the Semantic Kernel team:

microsoft/semantic-kernel#9612