fix: align realtime audio event types#3336
Open
nightcityblade wants to merge 1 commit into
Open
Conversation
nomiveritas
suggested changes
May 31, 2026
There was a problem hiding this comment.
"""The event type must be 'response.audio.done'."""
"""The event type must be 'response.audio_transcript.delta'."""
"""The event type must be 'response.audio_transcript.done'."""
We recommend correcting the docstring punctuation by removing the unnecessary commas in phrases such as "The event type, must be ...". The comma is grammatically incorrect and should be omitted.
This should be corrected as part of the change. The punctuation in the affected docstrings is grammatically incorrect and does not meet the expected documentation quality standards
Respectfully Nomiveritas Major Noémi
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.
Changes being requested
Fixes #2698.
Updates the non-beta realtime audio response event type literals to match the event names emitted by the API and already used by the beta realtime types:
response.audio.deltaresponse.audio.doneresponse.audio_transcript.deltaresponse.audio_transcript.doneAdds a small regression test that validates the four realtime audio event models accept those API event names.
Additional context & links
Tests run:
python3 -m ruff check src/openai/types/realtime/response_audio_delta_event.py src/openai/types/realtime/response_audio_done_event.py src/openai/types/realtime/response_audio_transcript_delta_event.py src/openai/types/realtime/response_audio_transcript_done_event.py tests/test_realtime_types.pypython3 -m pytest -o addopts='' tests/test_realtime_types.py