.Net: First step to make ChatMessageContent more serialization-friendly #5131
Conversation
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
…ialization to support the serialization/deserialization of the chat history class. This class contains messages with content items that are referenced polymorphically through the base KernelContent abstract class.
SergeyMenshykh
requested review from
dmytrostruk,
RogerBarreto and
markwallace-microsoft
markwallace-microsoft
added
kernel
….com/SergeyMenshykh/semantic-kernel into polymorphic-serialization-of-content
dmytrostruk
approved these changes
Feb 26, 2024
dotnet/samples/KernelSyntaxExamples/Example85_ChatHistorySerialization.cs
Outdated
Show resolved
Hide resolved
dotnet/src/SemanticKernel.Abstractions/Contents/KernelContent.cs
Outdated
Show resolved
Hide resolved
dotnet/src/SemanticKernel.UnitTests/Contents/ChatMessageContentTests.cs
Outdated
Show resolved
Hide resolved
Co-authored-by: Dmytro Struk <13853051+dmytrostruk@users.noreply.github.com>
…lization.cs Co-authored-by: Dmytro Struk <13853051+dmytrostruk@users.noreply.github.com>
…tTests.cs Co-authored-by: Dmytro Struk <13853051+dmytrostruk@users.noreply.github.com>
markwallace-microsoft
approved these changes
Feb 26, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation and Context
Today, it is not possible to deserialize ChatMessageContent that has at least one content item in the Items collection. The reason for this is that the content items in the Items collection are referenced polymorphically through the KernelContent abstract class. As a result, the deserialization process fails because it cannot create an instance of the abstract class. To solve the problem, the serialization process should save type information when serializing the Items collection so that the deserialization process can use this information to find the type that was serialized and create its instance. Therefore, this PR leverages type discriminators to save the type information and use it during deserialization.
Description
This PR registers the type discriminator for the KernelContent class and whitelists its subclasses to participate in polymorphic deserialization. On top of that, a few content types are modified to be serializable/deserializable.
Contribution Checklist