Fix serialization of OpenAIPromptExecutionSettings
with System.Type
in ResponseFormat
#13116
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.
Description:
This pull request addresses a serialization issue where setting the
ResponseFormat
property ofOpenAIPromptExecutionSettings
to aSystem.Type
would cause aSystem.NotSupportedException
during JSON serialization. This was due toSystem.Type
not being inherently JSON serializable, which broke scenarios that rely on serializing prompt execution settings.To resolve this, a custom
JsonConverter
(TypeOrFunctionResponseFormatConverter
) has been introduced. This converter interceptsSystem.Type
objects during serialization and correctly transforms them into the JSON schema format expected by the OpenAI API.Changes:
TypeOrFunctionResponseFormatConverter.cs
to handle the custom serialization logic forSystem.Type
.ResponseFormat
property inOpenAIPromptExecutionSettings.cs
.OpenAIPromptExecutionSettingsTests.cs
to verify that serialization now works as expected without throwing an exception.Validation:
The included unit test,
ItCanSerializeResponseFormatAsType
, now passes, confirming that theOpenAIPromptExecutionSettings
can be successfully serialized whenResponseFormat
is aSystem.Type
.Issue:
Fixes #13107