openai 0.92.0 → 0.94.0

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

@@ -12,18 +12,36 @@ module OpenAI
         }
 
       class ResponseReasoningSummaryTextDoneEvent < OpenAI::Internal::Type::BaseModel
+        # The ID of the item this summary text is associated with.
         attr_accessor item_id: String
 
+        # The index of the output item this summary text is associated with.
         attr_accessor output_index: Integer
 
+        # The sequence number of this event.
         attr_accessor sequence_number: Integer
 
+        # The index of the summary part within the reasoning summary.
         attr_accessor summary_index: Integer
 
+        # The full text of the completed reasoning summary.
         attr_accessor text: String
 
+        # The type of the event. Always `response.reasoning_summary_text.done`.
         attr_accessor type: :"response.reasoning_summary_text.done"
 
+        # @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 type
+        #   The type of the event. Always `response.reasoning_summary_text.done`.
         def initialize: (
           item_id: String,
           output_index: Integer,

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

@@ -12,18 +12,36 @@ module OpenAI
         }
 
       class ResponseReasoningTextDeltaEvent < OpenAI::Internal::Type::BaseModel
+        # The index of the reasoning content part this delta is associated with.
         attr_accessor content_index: Integer
 
+        # The text delta that was added to the reasoning content.
         attr_accessor delta: String
 
+        # The ID of the item this reasoning text delta is associated with.
         attr_accessor item_id: String
 
+        # The index of the output item this reasoning text delta is associated with.
         attr_accessor output_index: Integer
 
+        # The sequence number of this event.
         attr_accessor sequence_number: Integer
 
+        # The type of the event. Always `response.reasoning_text.delta`.
         attr_accessor type: :"response.reasoning_text.delta"
 
+        # @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 type
+        #   The type of the event. Always `response.reasoning_text.delta`.
         def initialize: (
           content_index: Integer,
           delta: String,

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

@@ -12,18 +12,36 @@ module OpenAI
         }
 
       class ResponseReasoningTextDoneEvent < OpenAI::Internal::Type::BaseModel
+        # The index of the reasoning content part.
         attr_accessor content_index: Integer
 
+        # The ID of the item this reasoning text is associated with.
         attr_accessor item_id: String
 
+        # The index of the output item this reasoning text is associated with.
         attr_accessor output_index: Integer
 
+        # The sequence number of this event.
         attr_accessor sequence_number: Integer
 
+        # The full text of the completed reasoning content.
         attr_accessor text: String
 
+        # The type of the event. Always `response.reasoning_text.done`.
         attr_accessor type: :"response.reasoning_text.done"
 
+        # @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 type
+        #   The type of the event. Always `response.reasoning_text.done`.
         def initialize: (
           content_index: Integer,
           item_id: String,

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

@@ -12,18 +12,36 @@ module OpenAI
         }
 
       class ResponseRefusalDeltaEvent < OpenAI::Internal::Type::BaseModel
+        # The index of the content part that the refusal text is added to.
         attr_accessor content_index: Integer
 
+        # The refusal text that is added.
         attr_accessor delta: String
 
+        # The ID of the output item that the refusal text is added to.
         attr_accessor item_id: String
 
+        # The index of the output item that the refusal text is added to.
         attr_accessor output_index: Integer
 
+        # The sequence number of this event.
         attr_accessor sequence_number: Integer
 
+        # The type of the event. Always `response.refusal.delta`.
         attr_accessor type: :"response.refusal.delta"
 
+        # @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 type
+        #   The type of the event. Always `response.refusal.delta`.
         def initialize: (
           content_index: Integer,
           delta: String,

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

@@ -12,18 +12,36 @@ module OpenAI
         }
 
       class ResponseRefusalDoneEvent < OpenAI::Internal::Type::BaseModel
+        # The index of the content part that the refusal text is finalized.
         attr_accessor content_index: Integer
 
+        # The ID of the output item that the refusal text is finalized.
         attr_accessor item_id: String
 
+        # The index of the output item that the refusal text is finalized.
         attr_accessor output_index: Integer
 
+        # The refusal text that is finalized.
         attr_accessor refusal: String
 
+        # The sequence number of this event.
         attr_accessor sequence_number: Integer
 
+        # The type of the event. Always `response.refusal.done`.
         attr_accessor type: :"response.refusal.done"
 
+        # @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 type
+        #   The type of the event. Always `response.refusal.done`.
         def initialize: (
           content_index: Integer,
           item_id: String,

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

@@ -16,20 +16,50 @@ module OpenAI
 
         attr_accessor response_id: String
 
+        # Additional fields to include in the response. See the `include` parameter for
+        # Response creation above for more information.
         attr_reader include: ::Array[OpenAI::Models::Responses::response_includable]?
 
+        # Additional fields to include in the response. See the `include` parameter for
+        # Response creation above for more information.
         def include=: (
           ::Array[OpenAI::Models::Responses::response_includable]
         ) -> ::Array[OpenAI::Models::Responses::response_includable]
 
+        # When true, stream obfuscation will be enabled. Stream obfuscation adds random
+        # characters to an `obfuscation` field on streaming delta events to normalize
+        # payload sizes as a mitigation to certain side-channel attacks. These obfuscation
+        # fields are included by default, but add a small amount of overhead to the data
+        # stream. You can set `include_obfuscation` to false to optimize for bandwidth if
+        # you trust the network links between your application and the OpenAI API.
         attr_reader include_obfuscation: bool?
 
+        # When true, stream obfuscation will be enabled. Stream obfuscation adds random
+        # characters to an `obfuscation` field on streaming delta events to normalize
+        # payload sizes as a mitigation to certain side-channel attacks. These obfuscation
+        # fields are included by default, but add a small amount of overhead to the data
+        # stream. You can set `include_obfuscation` to false to optimize for bandwidth if
+        # you trust the network links between your application and the OpenAI API.
         def include_obfuscation=: (bool) -> bool
 
+        # The sequence number of the event after which to start streaming.
         attr_reader starting_after: Integer?
 
+        # The sequence number of the event after which to start streaming.
         def starting_after=: (Integer) -> Integer
 
+        # @param include
+        #   Additional fields to include in the response. See the `include` parameter for
+        #   Response creation above for more information.
+        # @param include_obfuscation
+        #   When true, stream obfuscation will be enabled. Stream obfuscation adds random
+        #   characters to an `obfuscation` field on streaming delta events to normalize
+        #   payload sizes as a mitigation to certain side-channel attacks. These obfuscation
+        #   fields are included by default, but add a small amount of overhead to the data
+        #   stream. You can set `include_obfuscation` to false to optimize for bandwidth if
+        #   you trust the network links between your application and the OpenAI API.
+        # @param starting_after
+        #   The sequence number of the event after which to start streaming.
         def initialize: (
           response_id: String,
           ?include: ::Array[OpenAI::Models::Responses::response_includable],

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

@@ -11,16 +11,31 @@ module OpenAI
         }
 
       class ResponseShellCallCommandAddedEvent < OpenAI::Internal::Type::BaseModel
+        # The shell command that was added.
         attr_accessor command: String
 
+        # The index of the shell command that was added.
         attr_accessor command_index: Integer
 
+        # The index of the output item that was updated.
         attr_accessor output_index: Integer
 
+        # The sequence number of the event that was emitted.
         attr_accessor sequence_number: Integer
 
+        # The type of the event, always `response.shell_call_command.added`.
         attr_accessor type: :"response.shell_call_command.added"
 
+        # @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 type
+        #   The type of the event, always `response.shell_call_command.added`.
         def initialize: (
           command: String,
           command_index: Integer,

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

@@ -12,20 +12,39 @@ module OpenAI
         }
 
       class ResponseShellCallCommandDeltaEvent < OpenAI::Internal::Type::BaseModel
+        # The index of the shell command that was updated.
         attr_accessor command_index: Integer
 
+        # The shell command delta that was appended.
         attr_accessor delta: String
 
+        # The index of the output item that was updated.
         attr_accessor output_index: Integer
 
+        # The sequence number of the event that was emitted.
         attr_accessor sequence_number: Integer
 
+        # The type of the event, always `response.shell_call_command.delta`.
         attr_accessor type: :"response.shell_call_command.delta"
 
+        # An obfuscation string that was added to pad the event payload.
         attr_reader obfuscation: String?
 
+        # An obfuscation string that was added to pad the event payload.
         def obfuscation=: (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 type
+        #   The type of the event, always `response.shell_call_command.delta`.
         def initialize: (
           command_index: Integer,
           delta: String,

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

@@ -11,16 +11,31 @@ module OpenAI
         }
 
       class ResponseShellCallCommandDoneEvent < OpenAI::Internal::Type::BaseModel
+        # The final shell command that was emitted.
         attr_accessor command: String
 
+        # The index of the shell command that was completed.
         attr_accessor command_index: Integer
 
+        # The index of the output item that was updated.
         attr_accessor output_index: Integer
 
+        # The sequence number of the event that was emitted.
         attr_accessor sequence_number: Integer
 
+        # The type of the event, always `response.shell_call_command.done`.
         attr_accessor type: :"response.shell_call_command.done"
 
+        # @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 type
+        #   The type of the event, always `response.shell_call_command.done`.
         def initialize: (
           command: String,
           command_index: Integer,

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

@@ -12,18 +12,36 @@ module OpenAI
         }
 
       class ResponseShellCallOutputContentDeltaEvent < OpenAI::Internal::Type::BaseModel
+        # The index of the shell command that produced output.
         attr_accessor command_index: Integer
 
+        # The stdout/stderr delta that was emitted.
         attr_accessor delta: OpenAI::Responses::ResponseShellCallOutputContentDeltaEvent::Delta
 
+        # The ID of the output item that was updated.
         attr_accessor item_id: String
 
+        # The index of the output item that was updated.
         attr_accessor output_index: Integer
 
+        # The sequence number of the event that was emitted.
         attr_accessor sequence_number: Integer
 
+        # The type of the event, always `response.shell_call_output_content.delta`.
         attr_accessor type: :"response.shell_call_output_content.delta"
 
+        # @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 type
+        #   The type of the event, always `response.shell_call_output_content.delta`.
         def initialize: (
           command_index: Integer,
           delta: OpenAI::Responses::ResponseShellCallOutputContentDeltaEvent::Delta,
@@ -45,14 +63,22 @@ module OpenAI
         type delta = { ?stderr: String, ?stdout: String }
 
         class Delta < OpenAI::Internal::Type::BaseModel
+          # The stderr delta that was emitted.
           attr_reader stderr: String?
 
+          # The stderr delta that was emitted.
           def stderr=: (String) -> String
 
+          # The stdout delta that was emitted.
           attr_reader stdout: String?
 
+          # The stdout delta that was emitted.
           def stdout=: (String) -> String
 
+          # @param stderr
+          #   The stderr delta that was emitted.
+          # @param stdout
+          #   The stdout delta that was emitted.
           def initialize: (?stderr: String, ?stdout: String) -> void
 
           def to_hash: -> { ?stderr: String, ?stdout: String }

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

@@ -12,18 +12,36 @@ module OpenAI
         }
 
       class ResponseShellCallOutputContentDoneEvent < OpenAI::Internal::Type::BaseModel
+        # The index of the shell command that produced output.
         attr_accessor command_index: Integer
 
+        # The ID of the output item that was updated.
         attr_accessor item_id: String
 
+        # The output contents emitted for the shell command.
         attr_accessor output: ::Array[OpenAI::Responses::ResponseShellCallOutputContentDoneEvent::Output]
 
+        # The index of the output item that was updated.
         attr_accessor output_index: Integer
 
+        # The sequence number of the event that was emitted.
         attr_accessor sequence_number: Integer
 
+        # The type of the event, always `response.shell_call_output_content.done`.
         attr_accessor type: :"response.shell_call_output_content.done"
 
+        # @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 type
+        #   The type of the event, always `response.shell_call_output_content.done`.
         def initialize: (
           command_index: Integer,
           item_id: String,
@@ -51,16 +69,31 @@ module OpenAI
           }
 
         class Output < OpenAI::Internal::Type::BaseModel
+          # Represents either an exit outcome (with an exit code) or a timeout outcome for a
+          # shell call output chunk.
           attr_accessor outcome: OpenAI::Models::Responses::ResponseShellCallOutputContentDoneEvent::Output::outcome
 
+          # The standard error output that was captured.
           attr_accessor stderr: String
 
+          # The standard output that was captured.
           attr_accessor stdout: String
 
+          # The identifier of the actor that created the item.
           attr_reader created_by: String?
 
+          # The identifier of the actor that created the item.
           def created_by=: (String) -> String
 
+          # @param outcome
+          #   Represents either an exit outcome (with an exit code) or a timeout outcome for a
+          #   shell call output chunk.
+          # @param stderr
+          #   The standard error output that was captured.
+          # @param stdout
+          #   The standard output that was captured.
+          # @param created_by
+          #   The identifier of the actor that created the item.
           def initialize: (
             outcome: OpenAI::Models::Responses::ResponseShellCallOutputContentDoneEvent::Output::outcome,
             stderr: String,
@@ -85,8 +118,11 @@ module OpenAI
             type timeout = { ?type: :timeout }
 
             class Timeout < OpenAI::Internal::Type::BaseModel
+              # The outcome type. Always `timeout`.
               attr_accessor type: :timeout
 
+              # @param type
+              #   The outcome type. Always `timeout`.
               def initialize: (?type: :timeout) -> void
 
               def to_hash: -> { ?type: :timeout }
@@ -95,10 +131,16 @@ module OpenAI
             type exit_ = { exit_code: Integer, ?type: :exit }
 
             class Exit < OpenAI::Internal::Type::BaseModel
+              # Exit code from the shell process.
               attr_accessor exit_code: Integer
 
+              # The outcome type. Always `exit`.
               attr_accessor type: :exit
 
+              # @param exit_code
+              #   Exit code from the shell process.
+              # @param type
+              #   The outcome type. Always `exit`.
               def initialize: (exit_code: Integer, ?type: :exit) -> void
 
               def to_hash: -> { exit_code: Integer, ?type: :exit }

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

@@ -10,16 +10,32 @@ module OpenAI
         }
 
       class ResponseSteerAcceptedEvent < OpenAI::Internal::Type::BaseModel
+        # The sequence number for this event.
         attr_accessor sequence_number: Integer
 
+        # The accepted steering submission.
         attr_accessor steer: OpenAI::Responses::ResponseSteerAcceptedEvent::Steer
 
+        # The event discriminator. Always `response.steer.accepted`.
         attr_accessor type: :"response.steer.accepted"
 
+        # The WebSocket lane that emitted this event. This field is present when the
+        # target response's `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
+        # target response's `response.create` event supplied a `stream_id`.
         def stream_id=: (String) -> String
 
+        # @param sequence_number
+        #   The sequence number for this event.
+        # @param steer
+        #   The accepted steering submission.
+        # @param stream_id
+        #   The WebSocket lane that emitted this event. This field is present when the
+        #   target response's `response.create` event supplied a `stream_id`.
+        # @param type
+        #   The event discriminator. Always `response.steer.accepted`.
         def initialize: (
           sequence_number: Integer,
           steer: OpenAI::Responses::ResponseSteerAcceptedEvent::Steer,
@@ -37,10 +53,16 @@ module OpenAI
         type steer = { id: String, previous_response_id: String }
 
         class Steer < OpenAI::Internal::Type::BaseModel
+          # The ID assigned to the steering submission.
           attr_accessor id: String
 
+          # The ID of the response being steered.
           attr_accessor previous_response_id: String
 
+          # @param id
+          #   The ID assigned to the steering submission.
+          # @param previous_response_id
+          #   The ID of the response being steered.
           def initialize: (id: String, previous_response_id: String) -> void
 
           def to_hash: -> { id: String, previous_response_id: String }

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

@@ -9,12 +9,37 @@ module OpenAI
         }
 
       class ResponseSteerEvent < OpenAI::Internal::Type::BaseModel
+        # Input to queue for a continuation of the response. Uses the same string or
+        # input-item shape as `response.create.input`, with a non-empty array when
+        # supplying input items.
+        #
+        # Steering accepts only messages with the `user` role. Each message may contain
+        # only `type`, `role`, and `content`, with `content` as a string or an array of
+        # `input_text`, `input_image`, and `input_file` parts. The optional `type` must be
+        # `message`. Other roles, tool outputs, and item types are not supported for
+        # steering.
         attr_accessor input: OpenAI::Models::Responses::response_steer_input
 
+        # The ID of the response to steer on this WebSocket connection.
         attr_accessor previous_response_id: String
 
+        # The event discriminator. Always `response.steer`.
         attr_accessor type: :"response.steer"
 
+        # @param input
+        #   Input to queue for a continuation of the response. Uses the same string or
+        #   input-item shape as `response.create.input`, with a non-empty array when
+        #   supplying input items.
+        #
+        #   Steering accepts only messages with the `user` role. Each message may contain
+        #   only `type`, `role`, and `content`, with `content` as a string or an array of
+        #   `input_text`, `input_image`, and `input_file` parts. The optional `type` must be
+        #   `message`. Other roles, tool outputs, and item types are not supported for
+        #   steering.
+        # @param previous_response_id
+        #   The ID of the response to steer on this WebSocket connection.
+        # @param type
+        #   The event discriminator. Always `response.steer`.
         def initialize: (
           input: OpenAI::Models::Responses::response_steer_input,
           previous_response_id: String,