Python: Add extra_body attribute to OpenAI Chat settings - #11852
Merged
Conversation
markwallace-microsoft
added
the
python
Contributor
Python Unit Test Overview
|
moonbox3
enabled auto-merge
May 2, 2025 07:30
eavanvalkenburg
approved these changes
May 2, 2025
TaoChenOSU
approved these changes
May 2, 2025
github-merge-queue
Bot
removed this pull request from the merge queue due to failed status checks
May 2, 2025
glorious-beard
pushed a commit
to glorious-beard/semantic-kernel
that referenced
this pull request
May 6, 2025
…1852) ### Motivation and Context SK'S `OpenAIChatPromptExecutions` do not allow one to configure the `extra_body` input to a chat completions create. This is something specified on the Azure OpenAI connector but not on OpenAI. Because there are also custom attributes as part of AOAI, we're providing a base class attribute, and we will keep the child class attribute as-is. <!-- Thank you for your contribution to the semantic-kernel repo! Please help reviewers and future users, providing the following information: 1. Why is this change required? 2. What problem does it solve? 3. What scenario does it contribute to? 4. If it fixes an open issue, please link to the issue here. --> ### Description Introduce the `extra_body` attribute on OpenAI Chat Prompt Execution Settings. - Closes microsoft#11813 <!-- Describe your changes, the overall approach, the underlying design. These notes will help understanding how your code works. Thanks! --> ### 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 😄
|
dotnet need Add extra_body attribute to OpenAI Chat settings too |
jcruzmot-te
pushed a commit
to thousandeyes/aia-semantic-kernel
that referenced
this pull request
Sep 15, 2025
…1852) ### Motivation and Context SK'S `OpenAIChatPromptExecutions` do not allow one to configure the `extra_body` input to a chat completions create. This is something specified on the Azure OpenAI connector but not on OpenAI. Because there are also custom attributes as part of AOAI, we're providing a base class attribute, and we will keep the child class attribute as-is. <!-- Thank you for your contribution to the semantic-kernel repo! Please help reviewers and future users, providing the following information: 1. Why is this change required? 2. What problem does it solve? 3. What scenario does it contribute to? 4. If it fixes an open issue, please link to the issue here. --> ### Description Introduce the `extra_body` attribute on OpenAI Chat Prompt Execution Settings. - Closes microsoft#11813 <!-- Describe your changes, the overall approach, the underlying design. These notes will help understanding how your code works. Thanks! --> ### 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 😄
4 tasks
daric93
pushed a commit
to daric93/microsoft-semantic-kernel
that referenced
this pull request
Apr 30, 2026
microsoft#13934) ### Motivation and Context Closes microsoft#12307. Provides .NET parity with the Python fix in microsoft#11852 by adding an escape-hatch `ExtraBody` property to `OpenAIPromptExecutionSettings`. This allows callers to inject vendor-specific or preview parameters into the request body without waiting for SDK modeling. Use cases from the issue include: - Qwen3 open-source models requiring `enable_thinking: false` for non-streaming calls - ChatGLM thinking-mode flags - Any OpenAI-compatible endpoint exposing fields not modeled by the SDK ### Description Adds `IDictionary<string, object?>? ExtraBody` to `OpenAIPromptExecutionSettings` (inherited automatically by `AzureOpenAIPromptExecutionSettings`), marked `[Experimental("SKEXP0010")]`. #### Hybrid key syntax (diverges intentionally from Python to leverage the OpenAI .NET SDK's `JsonPatch`) - A plain key is treated as a literal top-level field name. Keys with dots, brackets, or other special characters are bracket-quoted automatically and remain literal. - `ExtraBody["enable_thinking"] = false` → `{ "enable_thinking": false }` - `ExtraBody["weird.key"] = "x"` → `{ "weird.key": "x" }` - A key starting with `$.` is interpreted as a JSONPath expression and applied as a deep patch onto the request body. - `ExtraBody["$.thinking.enabled"] = false` → `{ "thinking": { "enabled": false } }` - `ExtraBody["$.tools[0].function.name"] = "x"` → patches into array elements - Nested dictionaries are also supported via plain keys: `ExtraBody["thinking"] = new Dictionary<string,object?> { ["enabled"] = false }`. #### Behavior - **Last-write-wins on collisions** with strongly-typed properties (e.g. `Temperature`). Documented. - **`null` values emit JSON `null`**. Field removal is not supported. - **No input validation, no telemetry emission** of `ExtraBody` contents (Python parity). - **Shallow `Clone()`**, `ReadOnlyDictionary` on `Freeze()`. #### Wiring - Classic path: `ClientCore.ChatCompletion.cs` and `AzureClientCore.ChatCompletion.cs` apply patches at the end of `CreateChatCompletionOptions`. - `IChatClient` path: new `protected virtual PrepareChatOptionsForRequest(ChatOptions)` hook on `PromptExecutionSettings` (mirrors the existing `PrepareChatHistoryForRequest` pattern). The OpenAI override sets `ChatOptions.RawRepresentationFactory` and removes the redundant `AdditionalProperties["extra_body"]` entry produced by `ToChatOptions`'s round-trip. #### Files changed - `SemanticKernel.Abstractions/AI/PromptExecutionSettings.cs` — new hook + internal bridge - `SemanticKernel.Abstractions/AI/PromptExecutionSettingsExtensions.cs` — invokes the hook on the original derived instance - `Connectors.OpenAI/Settings/OpenAIPromptExecutionSettings.cs` — property, Freeze, Clone, `PrepareChatOptionsForRequest` override, `ApplyExtraBody`/`ApplyExtraBodyEntry` helpers - `Connectors.OpenAI/Core/ClientCore.ChatCompletion.cs` — apply in classic path - `Connectors.AzureOpenAI/Core/AzureClientCore.ChatCompletion.cs` — apply in Azure classic path - `samples/Concepts/ChatCompletion/OpenAI_ChatCompletionExtraBody.cs` — concept sample (flat field + deep patch) #### Tests (14 new, all passing) `Connectors.OpenAI.UnitTests` (11): non-streaming flat key, streaming flat key, collision (last-write-wins), nested dict, `$.` deep patch, literal dotted key, `null` value, `FromExecutionSettings` round-trip, Clone shallow, Freeze read-only, `ToChatOptions` `RawRepresentationFactory` + `AdditionalProperties` cleanup. `Connectors.AzureOpenAI.UnitTests` (3): flat key, collision, `$.` deep patch. #### Regression - `Connectors.OpenAI.UnitTests`: 485 passed - `Connectors.AzureOpenAI.UnitTests`: 493 passed - `SemanticKernel.UnitTests`: 1606 passed (verifies the new hook in Abstractions has no side effects) ### Contribution Checklist - [x] The code builds clean without any errors or warnings - [x] The PR follows the SK Contribution Guidelines and the pre-submission formatting script raises no violations - [x] All unit tests pass, and I have added new tests where possible - [x] I didn't break anyone 😄
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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
SK'S
OpenAIChatPromptExecutionsdo not allow one to configure theextra_bodyinput to a chat completions create. This is something specified on the Azure OpenAI connector but not on OpenAI. Because there are also custom attributes as part of AOAI, we're providing a base class attribute, and we will keep the child class attribute as-is.Description
Introduce the
extra_bodyattribute on OpenAI Chat Prompt Execution Settings.Contribution Checklist