Skip to content

Python: Add extra_body attribute to OpenAI Chat settings #11852

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 6, 2025

Conversation

moonbox3
Copy link
Contributor

@moonbox3 moonbox3 commented May 2, 2025

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.

Description

Introduce the extra_body attribute on OpenAI Chat Prompt Execution Settings.

Contribution Checklist

@moonbox3 moonbox3 requested a review from a team as a code owner May 2, 2025 07:04
@moonbox3 moonbox3 self-assigned this May 2, 2025
@markwallace-microsoft markwallace-microsoft added the python Pull requests for the Python Semantic Kernel label May 2, 2025
@markwallace-microsoft
Copy link
Member

Python Unit Test Overview

Tests Skipped Failures Errors Time
3472 5 💤 0 ❌ 0 🔥 1m 29s ⏱️

@moonbox3 moonbox3 enabled auto-merge May 2, 2025 07:30
@moonbox3 moonbox3 added this pull request to the merge queue May 2, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks May 2, 2025
@eavanvalkenburg eavanvalkenburg added this pull request to the merge queue May 6, 2025
Merged via the queue into microsoft:main with commit bc71548 May 6, 2025
30 checks passed
@github-project-automation github-project-automation bot moved this to Sprint: Done in Semantic Kernel May 6, 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 😄
@SherlockBULABULA
Copy link

dotnet need Add extra_body attribute to OpenAI Chat settings too

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
python Pull requests for the Python Semantic Kernel
Projects
Status: Sprint: Done
Development

Successfully merging this pull request may close these issues.

Python: New Feature: Can set extra_body for OpenAIChatPromptExecutionSettings
5 participants