openai 0.92.0 → 0.93.0

data/sig/openai/models/responses/responses_server_event.rbs

@@ -77,10 +77,23 @@ module OpenAI
           }
 
         class ResponseAudioWsDelta < OpenAI::Models::Responses::ResponseAudioDeltaEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param delta
+          #   A chunk of Base64 encoded response audio bytes.
+          # @param sequence_number
+          #   A sequence number for this chunk of the stream response.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always `response.audio.delta`.
           def initialize: (
             delta: String,
             sequence_number: Integer,
@@ -104,10 +117,21 @@ module OpenAI
           }
 
         class ResponseAudioWsDone < OpenAI::Models::Responses::ResponseAudioDoneEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param sequence_number
+          #   The sequence number of the delta.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always `response.audio.done`.
           def initialize: (
             sequence_number: Integer,
             ?stream_id: String,
@@ -130,10 +154,23 @@ module OpenAI
           }
 
         class ResponseAudioTranscriptWsDelta < OpenAI::Models::Responses::ResponseAudioTranscriptDeltaEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param delta
+          #   The partial transcript of the audio response.
+          # @param sequence_number
+          #   The sequence number of this event.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always `response.audio.transcript.delta`.
           def initialize: (
             delta: String,
             sequence_number: Integer,
@@ -157,10 +194,21 @@ module OpenAI
           }
 
         class ResponseAudioTranscriptWsDone < OpenAI::Models::Responses::ResponseAudioTranscriptDoneEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param sequence_number
+          #   The sequence number of this event.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always `response.audio.transcript.done`.
           def initialize: (
             sequence_number: Integer,
             ?stream_id: String,
@@ -185,10 +233,28 @@ module OpenAI
           }
 
         class ResponseCodeInterpreterCallCodeWsDelta < OpenAI::Models::Responses::ResponseCodeInterpreterCallCodeDeltaEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param delta
+          #   The partial code snippet being streamed by the code interpreter.
+          # @param item_id
+          #   The unique identifier of the code interpreter tool call item.
+          # @param output_index
+          #   The index of the output item in the response for which the code is being
+          #   streamed.
+          # @param sequence_number
+          #   The sequence number of this event, used to order streaming events.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always `response.code_interpreter_call_code.delta`.
           def initialize: (
             delta: String,
             item_id: String,
@@ -219,10 +285,27 @@ module OpenAI
           }
 
         class ResponseCodeInterpreterCallCodeWsDone < OpenAI::Models::Responses::ResponseCodeInterpreterCallCodeDoneEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param code
+          #   The final code snippet output by the code interpreter.
+          # @param item_id
+          #   The unique identifier of the code interpreter tool call item.
+          # @param output_index
+          #   The index of the output item in the response for which the code is finalized.
+          # @param sequence_number
+          #   The sequence number of this event, used to order streaming events.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always `response.code_interpreter_call_code.done`.
           def initialize: (
             code: String,
             item_id: String,
@@ -252,10 +335,26 @@ module OpenAI
           }
 
         class ResponseCodeInterpreterCallWsCompleted < OpenAI::Models::Responses::ResponseCodeInterpreterCallCompletedEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param item_id
+          #   The unique identifier of the code interpreter tool call item.
+          # @param output_index
+          #   The index of the output item in the response for which the code interpreter call
+          #   is completed.
+          # @param sequence_number
+          #   The sequence number of this event, used to order streaming events.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always `response.code_interpreter_call.completed`.
           def initialize: (
             item_id: String,
             output_index: Integer,
@@ -283,10 +382,26 @@ module OpenAI
           }
 
         class ResponseCodeInterpreterCallInWsProgress < OpenAI::Models::Responses::ResponseCodeInterpreterCallInProgressEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param item_id
+          #   The unique identifier of the code interpreter tool call item.
+          # @param output_index
+          #   The index of the output item in the response for which the code interpreter call
+          #   is in progress.
+          # @param sequence_number
+          #   The sequence number of this event, used to order streaming events.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always `response.code_interpreter_call.in_progress`.
           def initialize: (
             item_id: String,
             output_index: Integer,
@@ -314,10 +429,26 @@ module OpenAI
           }
 
         class ResponseCodeInterpreterCallWsInterpreting < OpenAI::Models::Responses::ResponseCodeInterpreterCallInterpretingEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param item_id
+          #   The unique identifier of the code interpreter tool call item.
+          # @param output_index
+          #   The index of the output item in the response for which the code interpreter is
+          #   interpreting code.
+          # @param sequence_number
+          #   The sequence number of this event, used to order streaming events.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always `response.code_interpreter_call.interpreting`.
           def initialize: (
             item_id: String,
             output_index: Integer,
@@ -345,10 +476,25 @@ module OpenAI
           }
 
         class ResponseCompactionWsCompacting < OpenAI::Models::Responses::ResponseCompactionCompactingEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param item_id
+          #   The ID of the compaction output item.
+          # @param output_index
+          #   The index of the compaction output item.
+          # @param sequence_number
+          #   The sequence number of the event that was emitted.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event, always `response.compaction.compacting`.
           def initialize: (
             item_id: String,
             output_index: Integer,
@@ -375,10 +521,23 @@ module OpenAI
           }
 
         class ResponseWsCompleted < OpenAI::Models::Responses::ResponseCompletedEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param response
+          #   Properties of the completed response.
+          # @param sequence_number
+          #   The sequence number for this event.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always `response.completed`.
           def initialize: (
             response: OpenAI::Responses::Response,
             sequence_number: Integer,
@@ -406,10 +565,29 @@ module OpenAI
           }
 
         class ResponseContentPartWsAdded < OpenAI::Models::Responses::ResponseContentPartAddedEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param content_index
+          #   The index of the content part that was added.
+          # @param item_id
+          #   The ID of the output item that the content part was added to.
+          # @param output_index
+          #   The index of the output item that the content part was added to.
+          # @param part
+          #   The content part that was added.
+          # @param sequence_number
+          #   The sequence number of this event.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always `response.content_part.added`.
           def initialize: (
             content_index: Integer,
             item_id: String,
@@ -443,10 +621,29 @@ module OpenAI
           }
 
         class ResponseContentPartWsDone < OpenAI::Models::Responses::ResponseContentPartDoneEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param content_index
+          #   The index of the content part that is done.
+          # @param item_id
+          #   The ID of the output item that the content part was added to.
+          # @param output_index
+          #   The index of the output item that the content part was added to.
+          # @param part
+          #   The content part that is done.
+          # @param sequence_number
+          #   The sequence number of this event.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always `response.content_part.done`.
           def initialize: (
             content_index: Integer,
             item_id: String,
@@ -477,10 +674,23 @@ module OpenAI
           }
 
         class ResponseWsCreated < OpenAI::Models::Responses::ResponseCreatedEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param response
+          #   The response that was created.
+          # @param sequence_number
+          #   The sequence number for this event.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always `response.created`.
           def initialize: (
             response: OpenAI::Responses::Response,
             sequence_number: Integer,
@@ -506,10 +716,25 @@ module OpenAI
           }
 
         class ResponseFileSearchCallWsCompleted < OpenAI::Models::Responses::ResponseFileSearchCallCompletedEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param item_id
+          #   The ID of the output item that the file search call is initiated.
+          # @param output_index
+          #   The index of the output item that the file search call is initiated.
+          # @param sequence_number
+          #   The sequence number of this event.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always `response.file_search_call.completed`.
           def initialize: (
             item_id: String,
             output_index: Integer,
@@ -537,10 +762,25 @@ module OpenAI
           }
 
         class ResponseFileSearchCallInWsProgress < OpenAI::Models::Responses::ResponseFileSearchCallInProgressEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param item_id
+          #   The ID of the output item that the file search call is initiated.
+          # @param output_index
+          #   The index of the output item that the file search call is initiated.
+          # @param sequence_number
+          #   The sequence number of this event.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always `response.file_search_call.in_progress`.
           def initialize: (
             item_id: String,
             output_index: Integer,
@@ -568,10 +808,25 @@ module OpenAI
           }
 
         class ResponseFileSearchCallWsSearching < OpenAI::Models::Responses::ResponseFileSearchCallSearchingEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param item_id
+          #   The ID of the output item that the file search call is initiated.
+          # @param output_index
+          #   The index of the output item that the file search call is searching.
+          # @param sequence_number
+          #   The sequence number of this event.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always `response.file_search_call.searching`.
           def initialize: (
             item_id: String,
             output_index: Integer,
@@ -600,10 +855,27 @@ module OpenAI
           }
 
         class ResponseFunctionCallArgumentsWsDelta < OpenAI::Models::Responses::ResponseFunctionCallArgumentsDeltaEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param delta
+          #   The function-call arguments delta that is added.
+          # @param item_id
+          #   The ID of the output item that the function-call arguments delta is added to.
+          # @param output_index
+          #   The index of the output item that the function-call arguments delta is added to.
+          # @param sequence_number
+          #   The sequence number of this event.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always `response.function_call_arguments.delta`.
           def initialize: (
             delta: String,
             item_id: String,
@@ -634,10 +906,25 @@ module OpenAI
           }
 
         class ResponseFunctionCallArgumentsWsDone < OpenAI::Models::Responses::ResponseFunctionCallArgumentsDoneEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param arguments
+          #   The function-call arguments.
+          # @param item_id
+          #   The ID of the item.
+          # @param output_index
+          #   The index of the output item.
+          # @param sequence_number
+          #   The sequence number of this event.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
           def initialize: (
             arguments: String,
             item_id: String,
@@ -668,10 +955,27 @@ module OpenAI
           }
 
         class ResponseShellCallCommandWsAdded < OpenAI::Models::Responses::ResponseShellCallCommandAddedEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param command
+          #   The shell command that was added.
+          # @param command_index
+          #   The index of the shell command that was added.
+          # @param output_index
+          #   The index of the output item that was updated.
+          # @param sequence_number
+          #   The sequence number of the event that was emitted.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event, always `response.shell_call_command.added`.
           def initialize: (
             command: String,
             command_index: Integer,
@@ -703,10 +1007,29 @@ module OpenAI
           }
 
         class ResponseShellCallCommandWsDelta < OpenAI::Models::Responses::ResponseShellCallCommandDeltaEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param command_index
+          #   The index of the shell command that was updated.
+          # @param delta
+          #   The shell command delta that was appended.
+          # @param output_index
+          #   The index of the output item that was updated.
+          # @param sequence_number
+          #   The sequence number of the event that was emitted.
+          # @param obfuscation
+          #   An obfuscation string that was added to pad the event payload.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event, always `response.shell_call_command.delta`.
           def initialize: (
             command_index: Integer,
             delta: String,
@@ -739,10 +1062,27 @@ module OpenAI
           }
 
         class ResponseShellCallCommandWsDone < OpenAI::Models::Responses::ResponseShellCallCommandDoneEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param command
+          #   The final shell command that was emitted.
+          # @param command_index
+          #   The index of the shell command that was completed.
+          # @param output_index
+          #   The index of the output item that was updated.
+          # @param sequence_number
+          #   The sequence number of the event that was emitted.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event, always `response.shell_call_command.done`.
           def initialize: (
             command: String,
             command_index: Integer,
@@ -774,10 +1114,29 @@ module OpenAI
           }
 
         class ResponseShellCallOutputContentWsDelta < OpenAI::Models::Responses::ResponseShellCallOutputContentDeltaEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param command_index
+          #   The index of the shell command that produced output.
+          # @param delta
+          #   The stdout/stderr delta that was emitted.
+          # @param item_id
+          #   The ID of the output item that was updated.
+          # @param output_index
+          #   The index of the output item that was updated.
+          # @param sequence_number
+          #   The sequence number of the event that was emitted.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event, always `response.shell_call_output_content.delta`.
           def initialize: (
             command_index: Integer,
             delta: OpenAI::Responses::ResponseShellCallOutputContentDeltaEvent::Delta,
@@ -811,10 +1170,29 @@ module OpenAI
           }
 
         class ResponseShellCallOutputContentWsDone < OpenAI::Models::Responses::ResponseShellCallOutputContentDoneEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param command_index
+          #   The index of the shell command that produced output.
+          # @param item_id
+          #   The ID of the output item that was updated.
+          # @param output
+          #   The output contents emitted for the shell command.
+          # @param output_index
+          #   The index of the output item that was updated.
+          # @param sequence_number
+          #   The sequence number of the event that was emitted.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event, always `response.shell_call_output_content.done`.
           def initialize: (
             command_index: Integer,
             item_id: String,
@@ -845,10 +1223,23 @@ module OpenAI
           }
 
         class ResponseInWsProgress < OpenAI::Models::Responses::ResponseInProgressEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param response
+          #   The response that is in progress.
+          # @param sequence_number
+          #   The sequence number of this event.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always `response.in_progress`.
           def initialize: (
             response: OpenAI::Responses::Response,
             sequence_number: Integer,
@@ -873,10 +1264,23 @@ module OpenAI
           }
 
         class ResponseWsFailed < OpenAI::Models::Responses::ResponseFailedEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param response
+          #   The response that failed.
+          # @param sequence_number
+          #   The sequence number of this event.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always `response.failed`.
           def initialize: (
             response: OpenAI::Responses::Response,
             sequence_number: Integer,
@@ -901,10 +1305,23 @@ module OpenAI
           }
 
         class ResponseWsIncomplete < OpenAI::Models::Responses::ResponseIncompleteEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param response
+          #   The response that was incomplete.
+          # @param sequence_number
+          #   The sequence number of this event.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always `response.incomplete`.
           def initialize: (
             response: OpenAI::Responses::Response,
             sequence_number: Integer,
@@ -930,10 +1347,28 @@ module OpenAI
           }
 
         class ResponseOutputItemWsAdded < OpenAI::Models::Responses::ResponseOutputItemAddedEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param item
+          #   The output item that was added. For reasoning items, `encrypted_content` may be
+          #   incomplete while the item is in progress. Use the reasoning item from the
+          #   corresponding `response.output_item.done` event when passing it as input to a
+          #   subsequent request.
+          # @param output_index
+          #   The index of the output item that was added.
+          # @param sequence_number
+          #   The sequence number of this event.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always `response.output_item.added`.
           def initialize: (
             item: OpenAI::Models::Responses::response_output_item,
             output_index: Integer,
@@ -961,10 +1396,25 @@ module OpenAI
           }
 
         class ResponseOutputItemWsDone < OpenAI::Models::Responses::ResponseOutputItemDoneEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param item
+          #   The output item that was marked done.
+          # @param output_index
+          #   The index of the output item that was marked done.
+          # @param sequence_number
+          #   The sequence number of this event.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always `response.output_item.done`.
           def initialize: (
             item: OpenAI::Models::Responses::response_output_item,
             output_index: Integer,
@@ -994,10 +1444,29 @@ module OpenAI
           }
 
         class ResponseReasoningSummaryPartWsAdded < OpenAI::Models::Responses::ResponseReasoningSummaryPartAddedEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param item_id
+          #   The ID of the item this summary part is associated with.
+          # @param output_index
+          #   The index of the output item this summary part is associated with.
+          # @param part
+          #   The summary part that was added.
+          # @param sequence_number
+          #   The sequence number of this event.
+          # @param summary_index
+          #   The index of the summary part within the reasoning summary.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always `response.reasoning_summary_part.added`.
           def initialize: (
             item_id: String,
             output_index: Integer,
@@ -1032,10 +1501,32 @@ module OpenAI
           }
 
         class ResponseReasoningSummaryPartWsDone < OpenAI::Models::Responses::ResponseReasoningSummaryPartDoneEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param item_id
+          #   The ID of the item this summary part is associated with.
+          # @param output_index
+          #   The index of the output item this summary part is associated with.
+          # @param part
+          #   The completed summary part.
+          # @param sequence_number
+          #   The sequence number of this event.
+          # @param summary_index
+          #   The index of the summary part within the reasoning summary.
+          # @param status
+          #   The completion status of the summary part. Omitted when the part completed
+          #   normally and set to `incomplete` when generation was interrupted.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always `response.reasoning_summary_part.done`.
           def initialize: (
             item_id: String,
             output_index: Integer,
@@ -1071,10 +1562,29 @@ module OpenAI
           }
 
         class ResponseReasoningSummaryTextWsDelta < OpenAI::Models::Responses::ResponseReasoningSummaryTextDeltaEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param delta
+          #   The text delta that was added to the summary.
+          # @param item_id
+          #   The ID of the item this summary text delta is associated with.
+          # @param output_index
+          #   The index of the output item this summary text delta is associated with.
+          # @param sequence_number
+          #   The sequence number of this event.
+          # @param summary_index
+          #   The index of the summary part within the reasoning summary.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always `response.reasoning_summary_text.delta`.
           def initialize: (
             delta: String,
             item_id: String,
@@ -1108,10 +1618,29 @@ module OpenAI
           }
 
         class ResponseReasoningSummaryTextWsDone < OpenAI::Models::Responses::ResponseReasoningSummaryTextDoneEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param item_id
+          #   The ID of the item this summary text is associated with.
+          # @param output_index
+          #   The index of the output item this summary text is associated with.
+          # @param sequence_number
+          #   The sequence number of this event.
+          # @param summary_index
+          #   The index of the summary part within the reasoning summary.
+          # @param text
+          #   The full text of the completed reasoning summary.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always `response.reasoning_summary_text.done`.
           def initialize: (
             item_id: String,
             output_index: Integer,
@@ -1145,10 +1674,29 @@ module OpenAI
           }
 
         class ResponseReasoningTextWsDelta < OpenAI::Models::Responses::ResponseReasoningTextDeltaEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param content_index
+          #   The index of the reasoning content part this delta is associated with.
+          # @param delta
+          #   The text delta that was added to the reasoning content.
+          # @param item_id
+          #   The ID of the item this reasoning text delta is associated with.
+          # @param output_index
+          #   The index of the output item this reasoning text delta is associated with.
+          # @param sequence_number
+          #   The sequence number of this event.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always `response.reasoning_text.delta`.
           def initialize: (
             content_index: Integer,
             delta: String,
@@ -1182,10 +1730,29 @@ module OpenAI
           }
 
         class ResponseReasoningTextWsDone < OpenAI::Models::Responses::ResponseReasoningTextDoneEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param content_index
+          #   The index of the reasoning content part.
+          # @param item_id
+          #   The ID of the item this reasoning text is associated with.
+          # @param output_index
+          #   The index of the output item this reasoning text is associated with.
+          # @param sequence_number
+          #   The sequence number of this event.
+          # @param text
+          #   The full text of the completed reasoning content.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always `response.reasoning_text.done`.
           def initialize: (
             content_index: Integer,
             item_id: String,
@@ -1219,10 +1786,29 @@ module OpenAI
           }
 
         class ResponseRefusalWsDelta < OpenAI::Models::Responses::ResponseRefusalDeltaEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param content_index
+          #   The index of the content part that the refusal text is added to.
+          # @param delta
+          #   The refusal text that is added.
+          # @param item_id
+          #   The ID of the output item that the refusal text is added to.
+          # @param output_index
+          #   The index of the output item that the refusal text is added to.
+          # @param sequence_number
+          #   The sequence number of this event.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always `response.refusal.delta`.
           def initialize: (
             content_index: Integer,
             delta: String,
@@ -1256,10 +1842,29 @@ module OpenAI
           }
 
         class ResponseRefusalWsDone < OpenAI::Models::Responses::ResponseRefusalDoneEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param content_index
+          #   The index of the content part that the refusal text is finalized.
+          # @param item_id
+          #   The ID of the output item that the refusal text is finalized.
+          # @param output_index
+          #   The index of the output item that the refusal text is finalized.
+          # @param refusal
+          #   The refusal text that is finalized.
+          # @param sequence_number
+          #   The sequence number of this event.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always `response.refusal.done`.
           def initialize: (
             content_index: Integer,
             item_id: String,
@@ -1294,10 +1899,31 @@ module OpenAI
           }
 
         class ResponseTextWsDelta < OpenAI::Models::Responses::ResponseTextDeltaEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param content_index
+          #   The index of the content part that the text delta was added to.
+          # @param delta
+          #   The text delta that was added.
+          # @param item_id
+          #   The ID of the output item that the text delta was added to.
+          # @param logprobs
+          #   The log probabilities of the tokens in the delta.
+          # @param output_index
+          #   The index of the output item that the text delta was added to.
+          # @param sequence_number
+          #   The sequence number for this event.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always `response.output_text.delta`.
           def initialize: (
             content_index: Integer,
             delta: String,
@@ -1334,10 +1960,31 @@ module OpenAI
           }
 
         class ResponseTextWsDone < OpenAI::Models::Responses::ResponseTextDoneEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param content_index
+          #   The index of the content part that the text content is finalized.
+          # @param item_id
+          #   The ID of the output item that the text content is finalized.
+          # @param logprobs
+          #   The log probabilities of the tokens in the delta.
+          # @param output_index
+          #   The index of the output item that the text content is finalized.
+          # @param sequence_number
+          #   The sequence number for this event.
+          # @param text
+          #   The text content that is finalized.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always `response.output_text.done`.
           def initialize: (
             content_index: Integer,
             item_id: String,
@@ -1371,10 +2018,25 @@ module OpenAI
           }
 
         class ResponseWebSearchCallWsCompleted < OpenAI::Models::Responses::ResponseWebSearchCallCompletedEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param item_id
+          #   Unique ID for the output item associated with the web search call.
+          # @param output_index
+          #   The index of the output item that the web search call is associated with.
+          # @param sequence_number
+          #   The sequence number of the web search call being processed.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always `response.web_search_call.completed`.
           def initialize: (
             item_id: String,
             output_index: Integer,
@@ -1402,10 +2064,25 @@ module OpenAI
           }
 
         class ResponseWebSearchCallInWsProgress < OpenAI::Models::Responses::ResponseWebSearchCallInProgressEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param item_id
+          #   Unique ID for the output item associated with the web search call.
+          # @param output_index
+          #   The index of the output item that the web search call is associated with.
+          # @param sequence_number
+          #   The sequence number of the web search call being processed.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always `response.web_search_call.in_progress`.
           def initialize: (
             item_id: String,
             output_index: Integer,
@@ -1433,10 +2110,25 @@ module OpenAI
           }
 
         class ResponseWebSearchCallWsSearching < OpenAI::Models::Responses::ResponseWebSearchCallSearchingEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param item_id
+          #   Unique ID for the output item associated with the web search call.
+          # @param output_index
+          #   The index of the output item that the web search call is associated with.
+          # @param sequence_number
+          #   The sequence number of the web search call being processed.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always `response.web_search_call.searching`.
           def initialize: (
             item_id: String,
             output_index: Integer,
@@ -1464,10 +2156,25 @@ module OpenAI
           }
 
         class ResponseImageGenCallWsCompleted < OpenAI::Models::Responses::ResponseImageGenCallCompletedEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param item_id
+          #   The unique identifier of the image generation item being processed.
+          # @param output_index
+          #   The index of the output item in the response's output array.
+          # @param sequence_number
+          #   The sequence number of this event.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always 'response.image_generation_call.completed'.
           def initialize: (
             item_id: String,
             output_index: Integer,
@@ -1495,10 +2202,25 @@ module OpenAI
           }
 
         class ResponseImageGenCallWsGenerating < OpenAI::Models::Responses::ResponseImageGenCallGeneratingEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param item_id
+          #   The unique identifier of the image generation item being processed.
+          # @param output_index
+          #   The index of the output item in the response's output array.
+          # @param sequence_number
+          #   The sequence number of the image generation item being processed.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always 'response.image_generation_call.generating'.
           def initialize: (
             item_id: String,
             output_index: Integer,
@@ -1526,10 +2248,25 @@ module OpenAI
           }
 
         class ResponseImageGenCallInWsProgress < OpenAI::Models::Responses::ResponseImageGenCallInProgressEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param item_id
+          #   The unique identifier of the image generation item being processed.
+          # @param output_index
+          #   The index of the output item in the response's output array.
+          # @param sequence_number
+          #   The sequence number of the image generation item being processed.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always 'response.image_generation_call.in_progress'.
           def initialize: (
             item_id: String,
             output_index: Integer,
@@ -1563,10 +2300,38 @@ module OpenAI
           }
 
         class ResponseImageGenCallPartialWsImage < OpenAI::Models::Responses::ResponseImageGenCallPartialImageEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param item_id
+          #   The unique identifier of the image generation item being processed.
+          # @param output_index
+          #   The index of the output item in the response's output array.
+          # @param partial_image_b64
+          #   Base64-encoded partial image data, suitable for rendering as an image.
+          # @param partial_image_index
+          #   0-based index for the partial image (backend is 1-based, but this is 0-based for
+          #   the user).
+          # @param sequence_number
+          #   The sequence number of the image generation item being processed.
+          # @param background
+          #   The background setting that was used.
+          # @param output_format
+          #   The output format that was used.
+          # @param quality
+          #   The image quality that was used.
+          # @param size
+          #   The image size that was used.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always 'response.image_generation_call.partial_image'.
           def initialize: (
             item_id: String,
             output_index: Integer,
@@ -1607,10 +2372,28 @@ module OpenAI
           }
 
         class ResponseMcpCallArgumentsWsDelta < OpenAI::Models::Responses::ResponseMcpCallArgumentsDeltaEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param delta
+          #   A JSON string containing the partial update to the arguments for the MCP tool
+          #   call.
+          # @param item_id
+          #   The unique identifier of the MCP tool call item being processed.
+          # @param output_index
+          #   The index of the output item in the response's output array.
+          # @param sequence_number
+          #   The sequence number of this event.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always 'response.mcp_call_arguments.delta'.
           def initialize: (
             delta: String,
             item_id: String,
@@ -1641,10 +2424,27 @@ module OpenAI
           }
 
         class ResponseMcpCallArgumentsWsDone < OpenAI::Models::Responses::ResponseMcpCallArgumentsDoneEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param arguments
+          #   A JSON string containing the finalized arguments for the MCP tool call.
+          # @param item_id
+          #   The unique identifier of the MCP tool call item being processed.
+          # @param output_index
+          #   The index of the output item in the response's output array.
+          # @param sequence_number
+          #   The sequence number of this event.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always 'response.mcp_call_arguments.done'.
           def initialize: (
             arguments: String,
             item_id: String,
@@ -1674,10 +2474,25 @@ module OpenAI
           }
 
         class ResponseMcpCallWsCompleted < OpenAI::Models::Responses::ResponseMcpCallCompletedEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param item_id
+          #   The ID of the MCP tool call item that completed.
+          # @param output_index
+          #   The index of the output item that completed.
+          # @param sequence_number
+          #   The sequence number of this event.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always 'response.mcp_call.completed'.
           def initialize: (
             item_id: String,
             output_index: Integer,
@@ -1705,10 +2520,25 @@ module OpenAI
           }
 
         class ResponseMcpCallWsFailed < OpenAI::Models::Responses::ResponseMcpCallFailedEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param item_id
+          #   The ID of the MCP tool call item that failed.
+          # @param output_index
+          #   The index of the output item that failed.
+          # @param sequence_number
+          #   The sequence number of this event.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always 'response.mcp_call.failed'.
           def initialize: (
             item_id: String,
             output_index: Integer,
@@ -1736,10 +2566,25 @@ module OpenAI
           }
 
         class ResponseMcpCallInWsProgress < OpenAI::Models::Responses::ResponseMcpCallInProgressEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param item_id
+          #   The unique identifier of the MCP tool call item being processed.
+          # @param output_index
+          #   The index of the output item in the response's output array.
+          # @param sequence_number
+          #   The sequence number of this event.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always 'response.mcp_call.in_progress'.
           def initialize: (
             item_id: String,
             output_index: Integer,
@@ -1767,10 +2612,25 @@ module OpenAI
           }
 
         class ResponseMcpListToolsWsCompleted < OpenAI::Models::Responses::ResponseMcpListToolsCompletedEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param item_id
+          #   The ID of the MCP tool call item that produced this output.
+          # @param output_index
+          #   The index of the output item that was processed.
+          # @param sequence_number
+          #   The sequence number of this event.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always 'response.mcp_list_tools.completed'.
           def initialize: (
             item_id: String,
             output_index: Integer,
@@ -1798,10 +2658,25 @@ module OpenAI
           }
 
         class ResponseMcpListToolsWsFailed < OpenAI::Models::Responses::ResponseMcpListToolsFailedEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param item_id
+          #   The ID of the MCP tool call item that failed.
+          # @param output_index
+          #   The index of the output item that failed.
+          # @param sequence_number
+          #   The sequence number of this event.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always 'response.mcp_list_tools.failed'.
           def initialize: (
             item_id: String,
             output_index: Integer,
@@ -1829,10 +2704,25 @@ module OpenAI
           }
 
         class ResponseMcpListToolsInWsProgress < OpenAI::Models::Responses::ResponseMcpListToolsInProgressEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param item_id
+          #   The ID of the MCP tool call item that is being processed.
+          # @param output_index
+          #   The index of the output item that is being processed.
+          # @param sequence_number
+          #   The sequence number of this event.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always 'response.mcp_list_tools.in_progress'.
           def initialize: (
             item_id: String,
             output_index: Integer,
@@ -1863,10 +2753,31 @@ module OpenAI
           }
 
         class ResponseOutputTextAnnotationWsAdded < OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param annotation
+          #   The annotation object being added. (See annotation schema for details.)
+          # @param annotation_index
+          #   The index of the annotation within the content part.
+          # @param content_index
+          #   The index of the content part within the output item.
+          # @param item_id
+          #   The unique identifier of the item to which the annotation is being added.
+          # @param output_index
+          #   The index of the output item in the response's output array.
+          # @param sequence_number
+          #   The sequence number of this event.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always 'response.output_text.annotation.added'.
           def initialize: (
             annotation: OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent::annotation?,
             annotation_index: Integer,
@@ -1899,10 +2810,23 @@ module OpenAI
           }
 
         class ResponseWsQueued < OpenAI::Models::Responses::ResponseQueuedEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param response
+          #   The full response object that is queued.
+          # @param sequence_number
+          #   The sequence number for this event.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always 'response.queued'.
           def initialize: (
             response: OpenAI::Responses::Response,
             sequence_number: Integer,
@@ -1929,10 +2853,27 @@ module OpenAI
           }
 
         class ResponseCustomToolCallInputWsDelta < OpenAI::Models::Responses::ResponseCustomToolCallInputDeltaEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param delta
+          #   The incremental input data (delta) for the custom tool call.
+          # @param item_id
+          #   Unique identifier for the API item associated with this event.
+          # @param output_index
+          #   The index of the output this delta applies to.
+          # @param sequence_number
+          #   The sequence number of this event.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The event type identifier.
           def initialize: (
             delta: String,
             item_id: String,
@@ -1963,10 +2904,27 @@ module OpenAI
           }
 
         class ResponseCustomToolCallInputWsDone < OpenAI::Models::Responses::ResponseCustomToolCallInputDoneEvent
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id: -> String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String _) -> String
 
+          # @param input
+          #   The complete input data for the custom tool call.
+          # @param item_id
+          #   Unique identifier for the API item associated with this event.
+          # @param output_index
+          #   The index of the output this event applies to.
+          # @param sequence_number
+          #   The sequence number of this event.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The event type identifier.
           def initialize: (
             input: String,
             item_id: String,
@@ -1996,22 +2954,43 @@ module OpenAI
           }
 
         class ResponseWsError < OpenAI::Internal::Type::BaseModel
+          # Details about the error.
           attr_accessor error: OpenAI::Responses::ResponsesServerEvent::ResponseWsError::Error
 
+          # The type of the event. Always `error`.
           attr_accessor type: :error
 
+          # The sequence number of an error emitted by the response stream.
           attr_reader sequence_number: Integer?
 
+          # The sequence number of an error emitted by the response stream.
           def sequence_number=: (Integer) -> Integer
 
+          # The HTTP status code associated with a WebSocket protocol error.
           attr_reader status: Integer?
 
+          # The HTTP status code associated with a WebSocket protocol error.
           def status=: (Integer) -> Integer
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           attr_reader stream_id: String?
 
+          # The WebSocket lane that emitted this event. This field is present when the
+          # originating `response.create` event supplied a `stream_id`.
           def stream_id=: (String) -> String
 
+          # @param error
+          #   Details about the error.
+          # @param sequence_number
+          #   The sequence number of an error emitted by the response stream.
+          # @param status
+          #   The HTTP status code associated with a WebSocket protocol error.
+          # @param stream_id
+          #   The WebSocket lane that emitted this event. This field is present when the
+          #   originating `response.create` event supplied a `stream_id`.
+          # @param type
+          #   The type of the event. Always `error`.
           def initialize: (
             error: OpenAI::Responses::ResponsesServerEvent::ResponseWsError::Error,
             ?sequence_number: Integer,
@@ -2039,16 +3018,22 @@ module OpenAI
             }
 
           class Error < OpenAI::Internal::Type::BaseModel
+            # The error code that was emitted, if any.
             attr_accessor code: String?
 
+            # The human-readable error message that was emitted.
             attr_accessor message: String
 
+            # The parameter name that was associated with the error, if any.
             attr_accessor param: String?
 
+            # The error type that was emitted.
             attr_accessor type: String
 
+            # The response headers that were emitted with the error, if any.
             attr_reader headers: ::Hash[Symbol, String]?
 
+            # The response headers that were emitted with the error, if any.
             def headers=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
 
             attr_reader misalignment: OpenAI::Responses::ResponsesServerEvent::ResponseWsError::Error::Misalignment?
@@ -2057,6 +3042,16 @@ module OpenAI
               OpenAI::Responses::ResponsesServerEvent::ResponseWsError::Error::Misalignment
             ) -> OpenAI::Responses::ResponsesServerEvent::ResponseWsError::Error::Misalignment
 
+            # @param code
+            #   The error code that was emitted, if any.
+            # @param message
+            #   The human-readable error message that was emitted.
+            # @param param
+            #   The parameter name that was associated with the error, if any.
+            # @param type
+            #   The error type that was emitted.
+            # @param headers
+            #   The response headers that were emitted with the error, if any.
             def initialize: (
               code: String?,
               message: String,
@@ -2083,22 +3078,34 @@ module OpenAI
               }
 
             class Misalignment < OpenAI::Internal::Type::BaseModel
+              # The public explanation for this block.
               attr_reader detailed_explanation: String?
 
+              # The public explanation for this block.
               def detailed_explanation=: (String) -> String
 
+              # An optional classification; clients must accept additional values.
               attr_reader error_type: OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsError::Error::Misalignment::error_type?
 
+              # An optional classification; clients must accept additional values.
               def error_type=: (
                 OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsError::Error::Misalignment::error_type
               ) -> OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsError::Error::Misalignment::error_type
 
+              # An optional public continuation instruction.
               attr_reader steer: OpenAI::Responses::ResponsesServerEvent::ResponseWsError::Error::Misalignment::Steer?
 
+              # An optional public continuation instruction.
               def steer=: (
                 OpenAI::Responses::ResponsesServerEvent::ResponseWsError::Error::Misalignment::Steer
               ) -> OpenAI::Responses::ResponsesServerEvent::ResponseWsError::Error::Misalignment::Steer
 
+              # @param detailed_explanation
+              #   The public explanation for this block.
+              # @param error_type
+              #   An optional classification; clients must accept additional values.
+              # @param steer
+              #   An optional public continuation instruction.
               def initialize: (
                 ?detailed_explanation: String,
                 ?error_type: OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsError::Error::Misalignment::error_type,
@@ -2132,8 +3139,11 @@ module OpenAI
               type steer = { message: String }
 
               class Steer < OpenAI::Internal::Type::BaseModel
+                # The public continuation instruction.
                 attr_accessor message: String
 
+                # @param message
+                #   The public continuation instruction.
                 def initialize: (message: String) -> void
 
                 def to_hash: -> { message: String }