openai 0.91.0 → 0.93.0

data/sig/openai/models/beta/beta_response_shell_call_output_content_delta_event.rbs

@@ -15,24 +15,46 @@ module OpenAI
         }
 
       class BetaResponseShellCallOutputContentDeltaEvent < 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::Beta::BetaResponseShellCallOutputContentDeltaEvent::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"
 
+        # The agent that owns this multi-agent streaming event.
         attr_reader agent: OpenAI::Beta::BetaResponseShellCallOutputContentDeltaEvent::Agent?
 
+        # The agent that owns this multi-agent streaming event.
         def agent=: (
           OpenAI::Beta::BetaResponseShellCallOutputContentDeltaEvent::Agent
         ) -> OpenAI::Beta::BetaResponseShellCallOutputContentDeltaEvent::Agent
 
+        # @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 agent
+        #   The agent that owns this multi-agent streaming event.
+        # @param type
+        #   The type of the event, always `response.shell_call_output_content.delta`.
         def initialize: (
           command_index: Integer,
           delta: OpenAI::Beta::BetaResponseShellCallOutputContentDeltaEvent::Delta,
@@ -56,14 +78,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 }
@@ -72,8 +102,11 @@ module OpenAI
         type agent = { agent_name: String }
 
         class Agent < OpenAI::Internal::Type::BaseModel
+          # The canonical name of the agent that produced this item.
           attr_accessor agent_name: String
 
+          # @param agent_name
+          #   The canonical name of the agent that produced this item.
           def initialize: (agent_name: String) -> void
 
           def to_hash: -> { agent_name: String }

data/sig/openai/models/beta/beta_response_shell_call_output_content_done_event.rbs

@@ -15,24 +15,46 @@ module OpenAI
         }
 
       class BetaResponseShellCallOutputContentDoneEvent < 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::Beta::BetaResponseShellCallOutputContentDoneEvent::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"
 
+        # The agent that owns this multi-agent streaming event.
         attr_reader agent: OpenAI::Beta::BetaResponseShellCallOutputContentDoneEvent::Agent?
 
+        # The agent that owns this multi-agent streaming event.
         def agent=: (
           OpenAI::Beta::BetaResponseShellCallOutputContentDoneEvent::Agent
         ) -> OpenAI::Beta::BetaResponseShellCallOutputContentDoneEvent::Agent
 
+        # @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 agent
+        #   The agent that owns this multi-agent streaming event.
+        # @param type
+        #   The type of the event, always `response.shell_call_output_content.done`.
         def initialize: (
           command_index: Integer,
           item_id: String,
@@ -62,16 +84,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::Beta::BetaResponseShellCallOutputContentDoneEvent::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::Beta::BetaResponseShellCallOutputContentDoneEvent::Output::outcome,
             stderr: String,
@@ -96,8 +133,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 }
@@ -106,10 +146,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 }
@@ -122,8 +168,11 @@ module OpenAI
         type agent = { agent_name: String }
 
         class Agent < OpenAI::Internal::Type::BaseModel
+          # The canonical name of the agent that produced this item.
           attr_accessor agent_name: String
 
+          # @param agent_name
+          #   The canonical name of the agent that produced this item.
           def initialize: (agent_name: String) -> void
 
           def to_hash: -> { agent_name: String }

data/sig/openai/models/beta/beta_response_steer_accepted_event.rbs

@@ -12,16 +12,32 @@ module OpenAI
         }
 
       class BetaResponseSteerAcceptedEvent < OpenAI::Internal::Type::BaseModel
+        # The sequence number for this event.
         attr_accessor sequence_number: Integer
 
+        # The accepted steering submission.
         attr_accessor steer: OpenAI::Beta::BetaResponseSteerAcceptedEvent::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::Beta::BetaResponseSteerAcceptedEvent::Steer,
@@ -39,10 +55,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/beta/beta_response_steer_event.rbs

@@ -11,12 +11,37 @@ module OpenAI
         }
 
       class BetaResponseSteerEvent < 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::Beta::beta_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::Beta::beta_response_steer_input,
           previous_response_id: String,

data/sig/openai/models/beta/beta_response_steer_failed_event.rbs

@@ -13,18 +13,37 @@ module OpenAI
         }
 
       class BetaResponseSteerFailedEvent < OpenAI::Internal::Type::BaseModel
+        # Information about why the input could not be committed.
         attr_accessor error: OpenAI::Beta::BetaResponseSteerFailedEvent::Error
 
+        # The sequence number for this event.
         attr_accessor sequence_number: Integer
 
+        # The steering submission that could not be committed.
         attr_accessor steer: OpenAI::Beta::BetaResponseSteerFailedEvent::Steer
 
+        # The event discriminator. Always `response.steer.failed`.
         attr_accessor type: :"response.steer.failed"
 
+        # The WebSocket lane that emitted this event, when the target response is
+        # available and its `response.create` event supplied a `stream_id`.
         attr_reader stream_id: String?
 
+        # The WebSocket lane that emitted this event, when the target response is
+        # available and its `response.create` event supplied a `stream_id`.
         def stream_id=: (String) -> String
 
+        # @param error
+        #   Information about why the input could not be committed.
+        # @param sequence_number
+        #   The sequence number for this event.
+        # @param steer
+        #   The steering submission that could not be committed.
+        # @param stream_id
+        #   The WebSocket lane that emitted this event, when the target response is
+        #   available and its `response.create` event supplied a `stream_id`.
+        # @param type
+        #   The event discriminator. Always `response.steer.failed`.
         def initialize: (
           error: OpenAI::Beta::BetaResponseSteerFailedEvent::Error,
           sequence_number: Integer,
@@ -49,12 +68,45 @@ module OpenAI
           }
 
         class Error < OpenAI::Internal::Type::BaseModel
+          # A machine-readable steering error code. Clients should handle unknown values
+          # because additional codes may be introduced. Known values include:
+          #
+          # - `response_not_found`: The target response is not available on this connection.
+          # - `invalid_input`: The event or input failed validation.
+          # - `steering_not_supported`: The model or response execution mode does not
+          #   support steering.
+          # - `too_many_pending_steers`: Too much steering input is pending for the
+          #   response.
+          # - `response_already_completed`: The response completed and is no longer
+          #   accepting steering input.
+          # - `response_not_active`: The response is no longer accepting steering input.
+          # - `successor_creation_failed`: The successor response could not be created.
           attr_accessor code: OpenAI::Models::Beta::beta_response_steer_error_code
 
+          # A human-readable description of the error.
           attr_accessor message: String
 
+          # The error type. Always `invalid_request_error`.
           attr_accessor type: :invalid_request_error
 
+          # @param code
+          #   A machine-readable steering error code. Clients should handle unknown values
+          #   because additional codes may be introduced. Known values include:
+          #
+          #   - `response_not_found`: The target response is not available on this connection.
+          #   - `invalid_input`: The event or input failed validation.
+          #   - `steering_not_supported`: The model or response execution mode does not
+          #     support steering.
+          #   - `too_many_pending_steers`: Too much steering input is pending for the
+          #     response.
+          #   - `response_already_completed`: The response completed and is no longer
+          #     accepting steering input.
+          #   - `response_not_active`: The response is no longer accepting steering input.
+          #   - `successor_creation_failed`: The successor response could not be created.
+          # @param message
+          #   A human-readable description of the error.
+          # @param type
+          #   The error type. Always `invalid_request_error`.
           def initialize: (
             code: OpenAI::Models::Beta::beta_response_steer_error_code,
             message: String,
@@ -76,14 +128,40 @@ module OpenAI
           }
 
         class Steer < 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::Beta::beta_response_steer_input
 
+          # The ID of the response that was targeted for steering.
           attr_accessor previous_response_id: String
 
+          # The ID assigned to the steering submission, if one was allocated.
           attr_reader id: String?
 
+          # The ID assigned to the steering submission, if one was allocated.
           def id=: (String) -> String
 
+          # @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 that was targeted for steering.
+          # @param id
+          #   The ID assigned to the steering submission, if one was allocated.
           def initialize: (
             input: OpenAI::Models::Beta::beta_response_steer_input,
             previous_response_id: String,

data/sig/openai/models/beta/beta_response_steer_input.rbs

@@ -28,18 +28,36 @@ module OpenAI
             }
 
           class Message < OpenAI::Internal::Type::BaseModel
+            # The message content, as an array of content parts.
             attr_accessor content: OpenAI::Models::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::Message::content
 
+            # The message role. Always `user`.
             attr_accessor role: :user
 
+            # The item type. Always `message`.
             attr_accessor type: :message
 
+            # The unique ID of this message item.
             attr_accessor id: String?
 
+            # The agent that produced this item.
             attr_accessor agent: OpenAI::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::Message::Agent?
 
+            # The status of the message item.
             attr_accessor status: String?
 
+            # @param content
+            #   The message content, as an array of content parts.
+            # @param id
+            #   The unique ID of this message item.
+            # @param agent
+            #   The agent that produced this item.
+            # @param status
+            #   The status of the message item.
+            # @param role
+            #   The message role. Always `user`.
+            # @param type
+            #   The item type. Always `message`.
             def initialize: (
               content: OpenAI::Models::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::Message::content,
               ?id: String?,
@@ -73,8 +91,11 @@ module OpenAI
             type agent = { agent_name: String }
 
             class Agent < OpenAI::Internal::Type::BaseModel
+              # The canonical name of the agent that produced this item.
               attr_accessor agent_name: String
 
+              # @param agent_name
+              #   The canonical name of the agent that produced this item.
               def initialize: (agent_name: String) -> void
 
               def to_hash: -> { agent_name: String }
@@ -95,24 +116,55 @@ module OpenAI
             }
 
           class FunctionCallOutput < OpenAI::Internal::Type::BaseModel
+            # Text, image, or file output of the function tool call.
             attr_accessor output: OpenAI::Models::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::FunctionCallOutput::output
 
+            # The type of the function tool call output. Always `function_call_output`.
             attr_accessor type: :function_call_output
 
+            # The unique ID of the function tool call output. Populated when this item is
+            # returned via API.
             attr_accessor id: String?
 
+            # The agent that produced this item.
             attr_accessor agent: OpenAI::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::FunctionCallOutput::Agent?
 
+            # The unique ID of the function tool call generated by the model.
             attr_accessor call_id: String?
 
+            # The execution context that produced this tool call.
             attr_accessor caller_: OpenAI::Models::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::FunctionCallOutput::caller_?
 
+            # The name of the tool that produced the output.
             attr_accessor name: String?
 
+            # The namespace of the tool that produced the output.
             attr_accessor namespace: String?
 
+            # The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+            # Populated when items are returned via API.
             attr_accessor status: OpenAI::Models::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::FunctionCallOutput::status?
 
+            # @param output
+            #   Text, image, or file output of the function tool call.
+            # @param id
+            #   The unique ID of the function tool call output. Populated when this item is
+            #   returned via API.
+            # @param agent
+            #   The agent that produced this item.
+            # @param call_id
+            #   The unique ID of the function tool call generated by the model.
+            # @param caller_
+            #   The execution context that produced this tool call.
+            # @param name
+            #   The name of the tool that produced the output.
+            # @param namespace
+            #   The namespace of the tool that produced the output.
+            # @param status
+            #   The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+            #   Populated when items are returned via API.
+            # @param type
+            #   The type of the function tool call output. Always `function_call_output`.
             def initialize: (
               output: OpenAI::Models::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::FunctionCallOutput::output,
               ?id: String?,
@@ -150,8 +202,11 @@ module OpenAI
             type agent = { agent_name: String }
 
             class Agent < OpenAI::Internal::Type::BaseModel
+              # The canonical name of the agent that produced this item.
               attr_accessor agent_name: String
 
+              # @param agent_name
+              #   The canonical name of the agent that produced this item.
               def initialize: (agent_name: String) -> void
 
               def to_hash: -> { agent_name: String }
@@ -167,8 +222,11 @@ module OpenAI
               type direct = { ?type: :direct }
 
               class Direct < OpenAI::Internal::Type::BaseModel
+                # The caller type. Always `direct`.
                 attr_accessor type: :direct
 
+                # @param type
+                #   The caller type. Always `direct`.
                 def initialize: (?type: :direct) -> void
 
                 def to_hash: -> { ?type: :direct }
@@ -177,10 +235,16 @@ module OpenAI
               type program = { caller_id: String, ?type: :program }
 
               class Program < OpenAI::Internal::Type::BaseModel
+                # The call ID of the program item that produced this tool call.
                 attr_accessor caller_id: String
 
+                # The caller type. Always `program`.
                 attr_accessor type: :program
 
+                # @param caller_id
+                #   The call ID of the program item that produced this tool call.
+                # @param type
+                #   The caller type. Always `program`.
                 def initialize: (caller_id: String, ?type: :program) -> void
 
                 def to_hash: -> { caller_id: String, ?type: :program }

data/sig/openai/models/beta/beta_response_steer_pending_event.rbs

@@ -14,20 +14,56 @@ module OpenAI
         }
 
       class BetaResponseSteerPendingEvent < OpenAI::Internal::Type::BaseModel
+        # An extensible enum describing why accepted steering input is still queued.
+        # Clients should handle unknown values because additional reasons may be
+        # introduced. Known values include:
+        #
+        # - `waiting_for_required_input`: The response is waiting for the tool results or
+        #   approval decisions identified by `required_input`.
         attr_accessor reason: OpenAI::Models::Beta::beta_response_steer_pending_reason
 
+        # Input stubs identifying outstanding client-owned tool results or approval
+        # decisions. Each stub contains identifying fields only; the client supplies the
+        # result before including it in `response.create`.
         attr_accessor required_input: ::Array[OpenAI::Models::Beta::beta_response_steer_required_input]
 
+        # The sequence number for this event.
         attr_accessor sequence_number: Integer
 
+        # The steering submission that remains queued.
         attr_accessor steer: OpenAI::Beta::BetaResponseSteerPendingEvent::Steer
 
+        # The event discriminator. Always `response.steer.pending`.
         attr_accessor type: :"response.steer.pending"
 
+        # 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 reason
+        #   An extensible enum describing why accepted steering input is still queued.
+        #   Clients should handle unknown values because additional reasons may be
+        #   introduced. Known values include:
+        #
+        #   - `waiting_for_required_input`: The response is waiting for the tool results or
+        #     approval decisions identified by `required_input`.
+        # @param required_input
+        #   Input stubs identifying outstanding client-owned tool results or approval
+        #   decisions. Each stub contains identifying fields only; the client supplies the
+        #   result before including it in `response.create`.
+        # @param sequence_number
+        #   The sequence number for this event.
+        # @param steer
+        #   The steering submission that remains queued.
+        # @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.pending`.
         def initialize: (
           reason: OpenAI::Models::Beta::beta_response_steer_pending_reason,
           required_input: ::Array[OpenAI::Models::Beta::beta_response_steer_required_input],
@@ -49,10 +85,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 }