fix(types): make logprobs Optional in response event types (fixes #2489)#2914
Open
giulio-leone wants to merge 1 commit intoopenai:mainfrom
Open
fix(types): make logprobs Optional in response event types (fixes #2489)#2914giulio-leone wants to merge 1 commit intoopenai:mainfrom
giulio-leone wants to merge 1 commit intoopenai:mainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This PR fixes issue #2489 by making the logprobs field optional (defaulting to None) in ResponseTextDeltaEvent and ResponseTextDoneEvent. Non-OpenAI providers (e.g., litellm, Anthropic proxies) may omit logprobs in streaming responses, which previously caused a pydantic ValidationError. The change aligns these event types with ResponseOutputText, which already treats logprobs as Optional.
Changes:
logprobsmadeOptional[List[Logprob]] = NoneinResponseTextDeltaEventlogprobsmadeOptional[List[Logprob]] = NoneinResponseTextDoneEvent- 6 regression tests added covering with/without/empty logprobs for both event types
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
src/openai/types/responses/response_text_delta_event.py |
Makes logprobs optional with a None default |
src/openai/types/responses/response_text_done_event.py |
Makes logprobs optional with a None default |
tests/test_response_event_logprobs.py |
Adds regression tests for the optional logprobs behavior |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
giulio-leone
added a commit
to giulio-leone/openai-python
that referenced
this pull request
Mar 2, 2026
Remove unused `pytest` and `Logprob` imports flagged by Copilot review. Refs: openai#2914
giulio-leone
force-pushed
the
fix/issue-2489-optional-logprobs
branch
from
3fc8453 to
799afa6
Compare
giulio-leone
added a commit
to giulio-leone/openai-python
that referenced
this pull request
Mar 2, 2026
Note that logprobs fields were manually changed to Optional in the auto-generated files, referencing issue openai#2489. Also fix import sorting in the test file. Refs: openai#2914
giulio-leone
force-pushed
the
fix/issue-2489-optional-logprobs
branch
from
aea1876 to
0571026
Compare
giulio-leone
added a commit
to giulio-leone/openai-python
that referenced
this pull request
Mar 2, 2026
giulio-leone
pushed a commit
to giulio-leone/openai-python
that referenced
this pull request
Mar 3, 2026
giulio-leone
force-pushed
the
fix/issue-2489-optional-logprobs
branch
from
ea170bb to
881445e
Compare
giulio-leone
added a commit
to giulio-leone/openai-python
that referenced
this pull request
Mar 4, 2026
giulio-leone
force-pushed
the
fix/issue-2489-optional-logprobs
branch
from
881445e to
85c4e54
Compare
giulio-leone
force-pushed
the
fix/issue-2489-optional-logprobs
branch
from
85c4e54 to
658b1f5
Compare
Author
|
Intervention note for this PR: Current blocker appears to be missing CI execution rather than failing jobs:
Suggested unblock sequence:
If useful, I can run a follow-up status sweep as soon as checks are attached. |
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
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.
Summary
Fixes #2489 — Validation error for
ResponseTextDeltaEventafter updating to v1.97.1.Root Cause
The
logprobsfield inResponseTextDeltaEventandResponseTextDoneEventis required, but non-OpenAI providers (litellm, Anthropic proxies) may not include it in streaming responses. This causes apydantic ValidationErrorwhen parsing those responses.Changes
logprobsfieldOptional[List[Logprob]] = Nonein:ResponseTextDeltaEventResponseTextDoneEventlogprobscontinue to work as beforeNote
ResponseOutputTextalready haslogprobsasOptional, so this aligns the event types with that pattern.Fixes #2489