Skip to content

.Net: First step to make ChatMessageContent more serialization-friendly#5131

Merged
SergeyMenshykh merged 13 commits intomicrosoft:mainfrom
SergeyMenshykh:polymorphic-serialization-of-content
Feb 26, 2024
Merged

.Net: First step to make ChatMessageContent more serialization-friendly#5131
SergeyMenshykh merged 13 commits intomicrosoft:mainfrom
SergeyMenshykh:polymorphic-serialization-of-content

Conversation

@SergeyMenshykh
Copy link
Member

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

…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 SergeyMenshykh added the .NET Issue or Pull requests regarding .NET code label Feb 23, 2024
@SergeyMenshykh SergeyMenshykh self-assigned this Feb 23, 2024
@SergeyMenshykh SergeyMenshykh requested a review from a team as a code owner February 23, 2024 16:09
@markwallace-microsoft markwallace-microsoft added kernel Issues or pull requests impacting the core kernel kernel.core labels Feb 23, 2024
@SergeyMenshykh SergeyMenshykh added this pull request to the merge queue Feb 26, 2024
Merged via the queue into microsoft:main with commit f40ea59 Feb 26, 2024
@SergeyMenshykh SergeyMenshykh deleted the polymorphic-serialization-of-content branch February 26, 2024 18:26
LudoCorporateShark pushed a commit to LudoCorporateShark/semantic-kernel that referenced this pull request Aug 25, 2024
…ly (microsoft#5131)

### 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](https://learn.microsoft.com/en-us/dotnet/standard/serialization/system-text-json/polymorphism?pivots=dotnet-8-0)
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

<!-- Before submitting this PR, please make sure: -->

- [x] The code builds clean without any errors or warnings
- [x] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [x] All unit tests pass, and I have added new tests where possible
- [x] I didn't break anyone 😄

---------

Co-authored-by: Dmytro Struk <13853051+dmytrostruk@users.noreply.github.com>
Bryan-Roe pushed a commit to Bryan-Roe-ai/semantic-kernel that referenced this pull request Oct 6, 2024
…ly (microsoft#5131)

### 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](https://learn.microsoft.com/en-us/dotnet/standard/serialization/system-text-json/polymorphism?pivots=dotnet-8-0)
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

<!-- Before submitting this PR, please make sure: -->

- [x] The code builds clean without any errors or warnings
- [x] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [x] All unit tests pass, and I have added new tests where possible
- [x] I didn't break anyone 😄

---------

Co-authored-by: Dmytro Struk <13853051+dmytrostruk@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kernel.core kernel Issues or pull requests impacting the core kernel .NET Issue or Pull requests regarding .NET code

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

3 participants