feat(realtime): Add usage field to input audio transcription completed event #724
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
Add the
usagefield toconversationItemInputAudioTranscriptionCompletedEventSchemaandInputAudioTranscriptionCompletedEventto expose token usage information for audio transcriptions.Problem
The OpenAI Realtime API includes a
usagefield in theconversation.item.input_audio_transcription.completedevent containing token usage information:{ "type": "conversation.item.input_audio_transcription.completed", "event_id": "event_XX", "item_id": "item_XX", "content_index": 0, "transcript": "Hey, can you hear me?", "usage": { "type": "tokens", "total_tokens": 22, "input_tokens": 13, "input_token_details": { "text_tokens": 0, "audio_tokens": 13 }, "output_tokens": 9 } }However, the SDK schema did not include this field. Since Zod schemas use
.strip()mode by default, theusagefield was silently removed during parsing, making it inaccessible to developers.Solution
usagefield to the Zod schema inopenaiRealtimeEvents.tsusagetype toInputAudioTranscriptionCompletedEventintransportLayerEvents.ts