openai / openai/openai-python

Pre-connect Realtime manager.send crashes on Omit in dict events

Open Beginner friendly
#3,402 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
31.6k
Forks
5.7k
Avg merge
1d 6h
Merged PRs (30d)
96

Description

AsyncRealtimeConnectionManager.send() / RealtimeConnectionManager.send() call json.dumps(event) on dict payloads, but post-connect connection.send() uses maybe_transform() which strips Omit/NotGiven.

Repro:

manager = client.realtime.connect(model="gpt-4o-realtime-preview")
manager.send({"type": "response.cancel", "event_id": omit})
# TypeError: Object of type Omit is not JSON serializable

PR incoming with regression test.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with AsyncRealtimeConnectionManager.send() and RealtimeConnectionManager.send(), then compare their json.dumps(event) path with post-connect connection.send() and maybe_transform(). Reproduce the Omit payload shown in the issue and add the mentioned regression test; done means pre-connect sends no longer raises the serialization error.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.