openai 0.87.0 → 0.89.0

data/lib/openai/models/beta/beta_response_shell_call_output_content_done_event.rb

@@ -52,20 +52,26 @@ module OpenAI
         # @!method initialize(command_index:, item_id:, output:, output_index:, sequence_number:, agent: nil, type: :"response.shell_call_output_content.done")
         #   A streaming event that indicated shell call output was completed.
         #
-        #   @param command_index [Integer] The index of the shell command that produced output.
+        #   @param command_index [Integer]
+        #     The index of the shell command that produced output.
         #
-        #   @param item_id [String] The ID of the output item that was updated.
+        #   @param item_id [String]
+        #     The ID of the output item that was updated.
         #
-        #   @param output [Array<OpenAI::Models::Beta::BetaResponseShellCallOutputContentDoneEvent::Output>] The output contents emitted for the shell command.
+        #   @param output [Array<OpenAI::Models::Beta::BetaResponseShellCallOutputContentDoneEvent::Output>]
+        #     The output contents emitted for the shell command.
         #
-        #   @param output_index [Integer] The index of the output item that was updated.
+        #   @param output_index [Integer]
+        #     The index of the output item that was updated.
         #
-        #   @param sequence_number [Integer] The sequence number of the event that was emitted.
+        #   @param sequence_number [Integer]
+        #     The sequence number of the event that was emitted.
         #
-        #   @param agent [OpenAI::Models::Beta::BetaResponseShellCallOutputContentDoneEvent::Agent] The agent that owns this multi-agent streaming event.
+        #   @param agent [OpenAI::Models::Beta::BetaResponseShellCallOutputContentDoneEvent::Agent]
+        #     The agent that owns this multi-agent streaming event.
         #
-        #   @param type [Symbol, :"response.shell_call_output_content.done"] The type of the event, always `response.shell_call_output_content.done`.
-
+        #   @param type [Symbol, :"response.shell_call_output_content.done"]
+        #     The type of the event, always `response.shell_call_output_content.done`.
         class Output < OpenAI::Internal::Type::BaseModel
           # @!attribute outcome
           #   Represents either an exit outcome (with an exit code) or a timeout outcome for a
@@ -96,19 +102,20 @@ module OpenAI
           optional :created_by, String
 
           # @!method initialize(outcome:, stderr:, stdout:, created_by: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Beta::BetaResponseShellCallOutputContentDoneEvent::Output} for
-          #   more details.
-          #
           #   The content of a shell tool call output that was emitted.
           #
-          #   @param outcome [OpenAI::Models::Beta::BetaResponseShellCallOutputContentDoneEvent::Output::Outcome::Timeout, OpenAI::Models::Beta::BetaResponseShellCallOutputContentDoneEvent::Output::Outcome::Exit] Represents either an exit outcome (with an exit code) or a timeout outcome for a
+          #   @param outcome [OpenAI::Models::Beta::BetaResponseShellCallOutputContentDoneEvent::Output::Outcome::Timeout, OpenAI::Models::Beta::BetaResponseShellCallOutputContentDoneEvent::Output::Outcome::Exit]
+          #     Represents either an exit outcome (with an exit code) or a timeout outcome for a
+          #     shell call output chunk.
           #
-          #   @param stderr [String] The standard error output that was captured.
+          #   @param stderr [String]
+          #     The standard error output that was captured.
           #
-          #   @param stdout [String] The standard output that was captured.
+          #   @param stdout [String]
+          #     The standard output that was captured.
           #
-          #   @param created_by [String] The identifier of the actor that created the item.
+          #   @param created_by [String]
+          #     The identifier of the actor that created the item.
 
           # Represents either an exit outcome (with an exit code) or a timeout outcome for a
           # shell call output chunk.
@@ -138,7 +145,8 @@ module OpenAI
               # @!method initialize(type: :timeout)
               #   Indicates that the shell call exceeded its configured time limit.
               #
-              #   @param type [Symbol, :timeout] The outcome type. Always `timeout`.
+              #   @param type [Symbol, :timeout]
+              #     The outcome type. Always `timeout`.
             end
 
             class Exit < OpenAI::Internal::Type::BaseModel
@@ -157,9 +165,11 @@ module OpenAI
               # @!method initialize(exit_code:, type: :exit)
               #   Indicates that the shell commands finished and returned an exit code.
               #
-              #   @param exit_code [Integer] Exit code from the shell process.
+              #   @param exit_code [Integer]
+              #     Exit code from the shell process.
               #
-              #   @param type [Symbol, :exit] The outcome type. Always `exit`.
+              #   @param type [Symbol, :exit]
+              #     The outcome type. Always `exit`.
             end
 
             # @!method self.variants
@@ -178,7 +188,8 @@ module OpenAI
           # @!method initialize(agent_name:)
           #   The agent that owns this multi-agent streaming event.
           #
-          #   @param agent_name [String] The canonical name of the agent that produced this item.
+          #   @param agent_name [String]
+          #     The canonical name of the agent that produced this item.
         end
       end
     end

data/lib/openai/models/beta/beta_response_steer_accepted_event.rb

@@ -30,9 +30,6 @@ module OpenAI
         optional :stream_id, String
 
         # @!method initialize(sequence_number:, steer:, stream_id: nil, type: :"response.steer.accepted")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Beta::BetaResponseSteerAcceptedEvent} for more details.
-        #
         #   Emitted when steering input has been validated and queued. Acceptance means the
         #   server owns the input, not that it has been applied. The successor's
         #   `response.created` event is the commit point. If accepted input cannot be
@@ -44,13 +41,18 @@ module OpenAI
         #   results and send one matching explicit `response.create` per parent. Do not
         #   resend accepted input while it is still queued.
         #
-        #   @param sequence_number [Integer] The sequence number for this event.
+        #   @param sequence_number [Integer]
+        #     The sequence number for this event.
         #
-        #   @param steer [OpenAI::Models::Beta::BetaResponseSteerAcceptedEvent::Steer] The accepted steering submission.
+        #   @param steer [OpenAI::Models::Beta::BetaResponseSteerAcceptedEvent::Steer]
+        #     The accepted steering submission.
         #
-        #   @param stream_id [String] The WebSocket lane that emitted this event. This field is present when
+        #   @param 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`.
         #
-        #   @param type [Symbol, :"response.steer.accepted"] The event discriminator. Always `response.steer.accepted`.
+        #   @param type [Symbol, :"response.steer.accepted"]
+        #     The event discriminator. Always `response.steer.accepted`.
 
         # @see OpenAI::Models::Beta::BetaResponseSteerAcceptedEvent#steer
         class Steer < OpenAI::Internal::Type::BaseModel
@@ -69,9 +71,11 @@ module OpenAI
           # @!method initialize(id:, previous_response_id:)
           #   The accepted steering submission.
           #
-          #   @param id [String] The ID assigned to the steering submission.
+          #   @param id [String]
+          #     The ID assigned to the steering submission.
           #
-          #   @param previous_response_id [String] The ID of the response being steered.
+          #   @param previous_response_id [String]
+          #     The ID of the response being steered.
         end
       end
     end

data/lib/openai/models/beta/beta_response_steer_event.rb

@@ -31,9 +31,6 @@ module OpenAI
         required :type, const: :"response.steer"
 
         # @!method initialize(input:, previous_response_id:, type: :"response.steer")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Beta::BetaResponseSteerEvent} for more details.
-        #
         #   Queues user input to steer a response on this WebSocket connection. Input can
         #   contain text, images, and files. Steering is supported only for single-agent
         #   responses on models and execution modes that support steering. Responses bound
@@ -62,11 +59,22 @@ module OpenAI
         #   This event accepts only `type`, `previous_response_id`, and `input`. Do not send
         #   `stream_id`; the target response determines the WebSocket lane.
         #
-        #   @param input [String, Array<Hash{Symbol=>Object}>] Input to queue for a continuation of the response. Uses the same string or
+        #   @param input [String, Array<Hash{Symbol=>Object}>]
+        #     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 [String] The ID of the response to steer on this WebSocket connection.
+        #   @param previous_response_id [String]
+        #     The ID of the response to steer on this WebSocket connection.
         #
-        #   @param type [Symbol, :"response.steer"] The event discriminator. Always `response.steer`.
+        #   @param type [Symbol, :"response.steer"]
+        #     The event discriminator. Always `response.steer`.
       end
     end
 

data/lib/openai/models/beta/beta_response_steer_failed_event.rb

@@ -36,9 +36,6 @@ module OpenAI
         optional :stream_id, String
 
         # @!method initialize(error:, sequence_number:, steer:, stream_id: nil, type: :"response.steer.failed")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Beta::BetaResponseSteerFailedEvent} for more details.
-        #
         #   Emitted when steering input is rejected or cannot be committed to a successor
         #   response. Returns the original, uncommitted input so the client can carry it
         #   into `response.create` when appropriate. Invalid input must be corrected before
@@ -48,15 +45,21 @@ module OpenAI
         #   allocated omit `steer.id`. A lost connection or missing acknowledgement leaves
         #   the outcome unknown; it is not proof that the input was rejected.
         #
-        #   @param error [OpenAI::Models::Beta::BetaResponseSteerFailedEvent::Error] Information about why the input could not be committed.
+        #   @param error [OpenAI::Models::Beta::BetaResponseSteerFailedEvent::Error]
+        #     Information about why the input could not be committed.
         #
-        #   @param sequence_number [Integer] The sequence number for this event.
+        #   @param sequence_number [Integer]
+        #     The sequence number for this event.
         #
-        #   @param steer [OpenAI::Models::Beta::BetaResponseSteerFailedEvent::Steer] The steering submission that could not be committed.
+        #   @param steer [OpenAI::Models::Beta::BetaResponseSteerFailedEvent::Steer]
+        #     The steering submission that could not be committed.
         #
-        #   @param stream_id [String] The WebSocket lane that emitted this event, when the target response is
+        #   @param 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`.
         #
-        #   @param type [Symbol, :"response.steer.failed"] The event discriminator. Always `response.steer.failed`.
+        #   @param type [Symbol, :"response.steer.failed"]
+        #     The event discriminator. Always `response.steer.failed`.
 
         # @see OpenAI::Models::Beta::BetaResponseSteerFailedEvent#error
         class Error < OpenAI::Internal::Type::BaseModel
@@ -91,16 +94,28 @@ module OpenAI
           required :type, const: :invalid_request_error
 
           # @!method initialize(code:, message:, type: :invalid_request_error)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Beta::BetaResponseSteerFailedEvent::Error} for more details.
-          #
           #   Information about why the input could not be committed.
           #
-          #   @param code [Symbol, String, OpenAI::Models::Beta::BetaResponseSteerErrorCode] A machine-readable steering error code. Clients should handle unknown
-          #
-          #   @param message [String] A human-readable description of the error.
-          #
-          #   @param type [Symbol, :invalid_request_error] The error type. Always `invalid_request_error`.
+          #   @param code [Symbol, String, OpenAI::Models::Beta::BetaResponseSteerErrorCode]
+          #     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 [String]
+          #     A human-readable description of the error.
+          #
+          #   @param type [Symbol, :invalid_request_error]
+          #     The error type. Always `invalid_request_error`.
         end
 
         # @see OpenAI::Models::Beta::BetaResponseSteerFailedEvent#steer
@@ -132,16 +147,24 @@ module OpenAI
           optional :id, String
 
           # @!method initialize(input:, previous_response_id:, id: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Beta::BetaResponseSteerFailedEvent::Steer} for more details.
-          #
           #   The steering submission that could not be committed.
           #
-          #   @param input [String, Array<Hash{Symbol=>Object}>] Input to queue for a continuation of the response. Uses the same string or
+          #   @param input [String, Array<Hash{Symbol=>Object}>]
+          #     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 [String] The ID of the response that was targeted for steering.
+          #   @param previous_response_id [String]
+          #     The ID of the response that was targeted for steering.
           #
-          #   @param id [String] The ID assigned to the steering submission, if one was allocated.
+          #   @param id [String]
+          #     The ID assigned to the steering submission, if one was allocated.
         end
       end
     end

data/lib/openai/models/beta/beta_response_steer_input.rb

@@ -80,17 +80,23 @@ module OpenAI
             optional :status, String, nil?: true
 
             # @!method initialize(content:, id: nil, agent: nil, status: nil, role: :user, type: :message)
-            #   @param content [Array<OpenAI::Models::Beta::BetaResponseInputTextContent, OpenAI::Models::Beta::BetaResponseInputImageContent, OpenAI::Models::Beta::BetaResponseInputFileContent>, String] The message content, as an array of content parts.
+            #   @param content [Array<OpenAI::Models::Beta::BetaResponseInputTextContent, OpenAI::Models::Beta::BetaResponseInputImageContent, OpenAI::Models::Beta::BetaResponseInputFileContent>, String]
+            #     The message content, as an array of content parts.
             #
-            #   @param id [String, nil] The unique ID of this message item.
+            #   @param id [String, nil]
+            #     The unique ID of this message item.
             #
-            #   @param agent [OpenAI::Models::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::Message::Agent, nil] The agent that produced this item.
+            #   @param agent [OpenAI::Models::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::Message::Agent, nil]
+            #     The agent that produced this item.
             #
-            #   @param status [String, nil] The status of the message item.
+            #   @param status [String, nil]
+            #     The status of the message item.
             #
-            #   @param role [Symbol, :user] The message role. Always `user`.
+            #   @param role [Symbol, :user]
+            #     The message role. Always `user`.
             #
-            #   @param type [Symbol, :message] The item type. Always `message`.
+            #   @param type [Symbol, :message]
+            #     The item type. Always `message`.
 
             # The message content, as an array of content parts.
             #
@@ -127,7 +133,8 @@ module OpenAI
               # @!method initialize(agent_name:)
               #   The agent that produced this item.
               #
-              #   @param agent_name [String] The canonical name of the agent that produced this item.
+              #   @param agent_name [String]
+              #     The canonical name of the agent that produced this item.
             end
           end
 
@@ -213,29 +220,36 @@ module OpenAI
             )
 
             # @!method initialize(output:, id: nil, agent: nil, call_id: nil, caller_: nil, name: nil, namespace: nil, status: nil, type: :function_call_output)
-            #   Some parameter documentations has been truncated, see
-            #   {OpenAI::Models::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::FunctionCallOutput}
-            #   for more details.
-            #
             #   The output of a function tool call.
             #
-            #   @param output [String, Array<OpenAI::Models::Beta::BetaResponseInputTextContent, OpenAI::Models::Beta::BetaResponseInputImageContent, OpenAI::Models::Beta::BetaResponseInputFileContent>] Text, image, or file output of the function tool call.
+            #   @param output [String, Array<OpenAI::Models::Beta::BetaResponseInputTextContent, OpenAI::Models::Beta::BetaResponseInputImageContent, OpenAI::Models::Beta::BetaResponseInputFileContent>]
+            #     Text, image, or file output of the function tool call.
             #
-            #   @param id [String, nil] The unique ID of the function tool call output. Populated when this item is retu
+            #   @param id [String, nil]
+            #     The unique ID of the function tool call output. Populated when this item is
+            #     returned via API.
             #
-            #   @param agent [OpenAI::Models::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::FunctionCallOutput::Agent, nil] The agent that produced this item.
+            #   @param agent [OpenAI::Models::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::FunctionCallOutput::Agent, nil]
+            #     The agent that produced this item.
             #
-            #   @param call_id [String, nil] The unique ID of the function tool call generated by the model.
+            #   @param call_id [String, nil]
+            #     The unique ID of the function tool call generated by the model.
             #
-            #   @param caller_ [OpenAI::Models::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::FunctionCallOutput::Caller::Direct, OpenAI::Models::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::FunctionCallOutput::Caller::Program, nil] The execution context that produced this tool call.
+            #   @param caller_ [OpenAI::Models::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::FunctionCallOutput::Caller::Direct, OpenAI::Models::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::FunctionCallOutput::Caller::Program, nil]
+            #     The execution context that produced this tool call.
             #
-            #   @param name [String, nil] The name of the tool that produced the output.
+            #   @param name [String, nil]
+            #     The name of the tool that produced the output.
             #
-            #   @param namespace [String, nil] The namespace of the tool that produced the output.
+            #   @param namespace [String, nil]
+            #     The namespace of the tool that produced the output.
             #
-            #   @param status [Symbol, OpenAI::Models::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::FunctionCallOutput::Status, nil] The status of the item. One of `in_progress`, `completed`, or `incomplete`. Popu
+            #   @param status [Symbol, OpenAI::Models::Beta::BetaResponseSteerInput::ResponseSteerInputItemList::FunctionCallOutput::Status, nil]
+            #     The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+            #     Populated when items are returned via API.
             #
-            #   @param type [Symbol, :function_call_output] The type of the function tool call output. Always `function_call_output`.
+            #   @param type [Symbol, :function_call_output]
+            #     The type of the function tool call output. Always `function_call_output`.
 
             # Text, image, or file output of the function tool call.
             #
@@ -264,7 +278,8 @@ module OpenAI
               # @!method initialize(agent_name:)
               #   The agent that produced this item.
               #
-              #   @param agent_name [String] The canonical name of the agent that produced this item.
+              #   @param agent_name [String]
+              #     The canonical name of the agent that produced this item.
             end
 
             # The execution context that produced this tool call.
@@ -297,7 +312,8 @@ module OpenAI
                 required :type, const: :direct
 
                 # @!method initialize(type: :direct)
-                #   @param type [Symbol, :direct] The caller type. Always `direct`.
+                #   @param type [Symbol, :direct]
+                #     The caller type. Always `direct`.
               end
 
               class Program < OpenAI::Internal::Type::BaseModel
@@ -314,9 +330,11 @@ module OpenAI
                 required :type, const: :program
 
                 # @!method initialize(caller_id:, type: :program)
-                #   @param caller_id [String] The call ID of the program item that produced this tool call.
+                #   @param caller_id [String]
+                #     The call ID of the program item that produced this tool call.
                 #
-                #   @param type [Symbol, :program] The caller type. Always `program`.
+                #   @param type [Symbol, :program]
+                #     The caller type. Always `program`.
               end
 
               # @!method self.variants

data/lib/openai/models/beta/beta_response_steer_input_content.rb

@@ -12,7 +12,7 @@ module OpenAI
         # A text input to the model.
         variant :input_text, -> { OpenAI::Beta::BetaResponseInputTextContent }
 
-        # An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision)
+        # An image input to the model. Learn about [image inputs](https://developers.openai.com/api/docs/guides/images-vision)
         variant :input_image, -> { OpenAI::Beta::BetaResponseInputImageContent }
 
         # A file input to the model.

data/lib/openai/models/beta/beta_response_steer_pending_event.rb

@@ -52,9 +52,6 @@ module OpenAI
         optional :stream_id, String
 
         # @!method initialize(reason:, required_input:, sequence_number:, steer:, stream_id: nil, type: :"response.steer.pending")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Beta::BetaResponseSteerPendingEvent} for more details.
-        #
         #   Emitted when accepted steering input remains queued after the target response
         #   completes. The server still owns the input. Do not resend it. The successor's
         #   `response.created` event is the commit point.
@@ -72,17 +69,31 @@ module OpenAI
         #   submissions for the same parent can report the same required inputs; they do not
         #   each require a separate continuation.
         #
-        #   @param reason [Symbol, :waiting_for_required_input, String] An extensible enum describing why accepted steering input is still queued.
+        #   @param reason [Symbol, :waiting_for_required_input, String]
+        #     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 [Array<OpenAI::Models::Beta::BetaResponseSteerRequiredInput::FunctionCallOutput, OpenAI::Models::Beta::BetaResponseSteerRequiredInput::CustomToolCallOutput, OpenAI::Models::Beta::BetaResponseSteerRequiredInput::ComputerCallOutput, OpenAI::Models::Beta::BetaResponseSteerRequiredInput::ShellCallOutput, OpenAI::Models::Beta::BetaResponseSteerRequiredInput::ApplyPatchCallOutput, OpenAI::Models::Beta::BetaResponseSteerRequiredInput::ToolSearchOutput, OpenAI::Models::Beta::BetaResponseSteerRequiredInput::McpApprovalResponse>] Input stubs identifying outstanding client-owned tool results or
+        #   @param required_input [Array<OpenAI::Models::Beta::BetaResponseSteerRequiredInput::FunctionCallOutput, OpenAI::Models::Beta::BetaResponseSteerRequiredInput::CustomToolCallOutput, OpenAI::Models::Beta::BetaResponseSteerRequiredInput::ComputerCallOutput, OpenAI::Models::Beta::BetaResponseSteerRequiredInput::ShellCallOutput, OpenAI::Models::Beta::BetaResponseSteerRequiredInput::ApplyPatchCallOutput, OpenAI::Models::Beta::BetaResponseSteerRequiredInput::ToolSearchOutput, OpenAI::Models::Beta::BetaResponseSteerRequiredInput::McpApprovalResponse>]
+        #     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 [Integer] The sequence number for this event.
+        #   @param sequence_number [Integer]
+        #     The sequence number for this event.
         #
-        #   @param steer [OpenAI::Models::Beta::BetaResponseSteerPendingEvent::Steer] The steering submission that remains queued.
+        #   @param steer [OpenAI::Models::Beta::BetaResponseSteerPendingEvent::Steer]
+        #     The steering submission that remains queued.
         #
-        #   @param stream_id [String] The WebSocket lane that emitted this event. This field is present when
+        #   @param 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`.
         #
-        #   @param type [Symbol, :"response.steer.pending"] The event discriminator. Always `response.steer.pending`.
+        #   @param type [Symbol, :"response.steer.pending"]
+        #     The event discriminator. Always `response.steer.pending`.
 
         # @see OpenAI::Models::Beta::BetaResponseSteerPendingEvent#steer
         class Steer < OpenAI::Internal::Type::BaseModel
@@ -101,9 +112,11 @@ module OpenAI
           # @!method initialize(id:, previous_response_id:)
           #   The steering submission that remains queued.
           #
-          #   @param id [String] The ID assigned to the steering submission.
+          #   @param id [String]
+          #     The ID assigned to the steering submission.
           #
-          #   @param previous_response_id [String] The ID of the response being steered.
+          #   @param previous_response_id [String]
+          #     The ID of the response being steered.
         end
       end
     end

data/lib/openai/models/beta/beta_response_text_config.rb

@@ -9,7 +9,7 @@ module OpenAI
         #
         #   Configuring `{ "type": "json_schema" }` enables Structured Outputs, which
         #   ensures the model will match your supplied JSON schema. Learn more in the
-        #   [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).
+        #   [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
         #
         #   The default format is `{ "type": "text" }` with no additional options.
         #
@@ -32,18 +32,32 @@ module OpenAI
         optional :verbosity, enum: -> { OpenAI::Beta::BetaResponseTextConfig::Verbosity }, nil?: true
 
         # @!method initialize(format_: nil, verbosity: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Beta::BetaResponseTextConfig} for more details.
-        #
         #   Configuration options for a text response from the model. Can be plain text or
         #   structured JSON data. Learn more:
         #
-        #   - [Text inputs and outputs](https://platform.openai.com/docs/guides/text)
-        #   - [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs)
+        #   - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
+        #   - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)
+        #
+        #   @param format_ [OpenAI::Models::Beta::BetaResponseFormatTextConfig::Text, OpenAI::Models::Beta::BetaResponseFormatTextJSONSchemaConfig, OpenAI::Models::Beta::BetaResponseFormatTextConfig::JSONObject]
+        #     An object specifying the format that the model must output.
+        #
+        #     Configuring `{ "type": "json_schema" }` enables Structured Outputs, which
+        #     ensures the model will match your supplied JSON schema. Learn more in the
+        #     [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
+        #
+        #     The default format is `{ "type": "text" }` with no additional options.
+        #
+        #     **Not recommended for gpt-4o and newer models:**
         #
-        #   @param format_ [OpenAI::Models::Beta::BetaResponseFormatTextConfig::Text, OpenAI::Models::Beta::BetaResponseFormatTextJSONSchemaConfig, OpenAI::Models::Beta::BetaResponseFormatTextConfig::JSONObject] An object specifying the format that the model must output.
+        #     Setting to `{ "type": "json_object" }` enables the older JSON mode, which
+        #     ensures the message the model generates is valid JSON. Using `json_schema` is
+        #     preferred for models that support it.
         #
-        #   @param verbosity [Symbol, OpenAI::Models::Beta::BetaResponseTextConfig::Verbosity, nil] Constrains the verbosity of the model's response. Lower values will result in
+        #   @param verbosity [Symbol, OpenAI::Models::Beta::BetaResponseTextConfig::Verbosity, nil]
+        #     Constrains the verbosity of the model's response. Lower values will result in
+        #     more concise responses, while higher values will result in more verbose
+        #     responses. Currently supported values are `low`, `medium`, and `high`. The
+        #     default is `medium`.
 
         # Constrains the verbosity of the model's response. Lower values will result in
         # more concise responses, while higher values will result in more verbose

data/lib/openai/models/beta/beta_response_text_delta_event.rb

@@ -56,27 +56,31 @@ module OpenAI
         optional :agent, -> { OpenAI::Beta::BetaResponseTextDeltaEvent::Agent }, nil?: true
 
         # @!method initialize(content_index:, delta:, item_id:, logprobs:, output_index:, sequence_number:, agent: nil, type: :"response.output_text.delta")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Beta::BetaResponseTextDeltaEvent} for more details.
-        #
         #   Emitted when there is an additional text delta.
         #
-        #   @param content_index [Integer] The index of the content part that the text delta was added to.
+        #   @param content_index [Integer]
+        #     The index of the content part that the text delta was added to.
         #
-        #   @param delta [String] The text delta that was added.
+        #   @param delta [String]
+        #     The text delta that was added.
         #
-        #   @param item_id [String] The ID of the output item that the text delta was added to.
+        #   @param item_id [String]
+        #     The ID of the output item that the text delta was added to.
         #
-        #   @param logprobs [Array<OpenAI::Models::Beta::BetaResponseTextDeltaEvent::Logprob>] The log probabilities of the tokens in the delta.
+        #   @param logprobs [Array<OpenAI::Models::Beta::BetaResponseTextDeltaEvent::Logprob>]
+        #     The log probabilities of the tokens in the delta.
         #
-        #   @param output_index [Integer] The index of the output item that the text delta was added to.
+        #   @param output_index [Integer]
+        #     The index of the output item that the text delta was added to.
         #
-        #   @param sequence_number [Integer] The sequence number for this event.
+        #   @param sequence_number [Integer]
+        #     The sequence number for this event.
         #
-        #   @param agent [OpenAI::Models::Beta::BetaResponseTextDeltaEvent::Agent, nil] The agent that owns this multi-agent streaming event.
+        #   @param agent [OpenAI::Models::Beta::BetaResponseTextDeltaEvent::Agent, nil]
+        #     The agent that owns this multi-agent streaming event.
         #
-        #   @param type [Symbol, :"response.output_text.delta"] The type of the event. Always `response.output_text.delta`.
-
+        #   @param type [Symbol, :"response.output_text.delta"]
+        #     The type of the event. Always `response.output_text.delta`.
         class Logprob < OpenAI::Internal::Type::BaseModel
           # @!attribute token
           #   A possible text token.
@@ -100,19 +104,18 @@ module OpenAI
           )
 
           # @!method initialize(token:, logprob:, top_logprobs: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Beta::BetaResponseTextDeltaEvent::Logprob} for more details.
-          #
           #   A logprob is the logarithmic probability that the model assigns to producing a
           #   particular token at a given position in the sequence. Less-negative (higher)
           #   logprob values indicate greater model confidence in that token choice.
           #
-          #   @param token [String] A possible text token.
+          #   @param token [String]
+          #     A possible text token.
           #
-          #   @param logprob [Float] The log probability of this token.
+          #   @param logprob [Float]
+          #     The log probability of this token.
           #
-          #   @param top_logprobs [Array<OpenAI::Models::Beta::BetaResponseTextDeltaEvent::Logprob::TopLogprob>] The log probabilities of up to 20 of the most likely tokens.
-
+          #   @param top_logprobs [Array<OpenAI::Models::Beta::BetaResponseTextDeltaEvent::Logprob::TopLogprob>]
+          #     The log probabilities of up to 20 of the most likely tokens.
           class TopLogprob < OpenAI::Internal::Type::BaseModel
             # @!attribute token
             #   A possible text token.
@@ -127,9 +130,11 @@ module OpenAI
             optional :logprob, Float
 
             # @!method initialize(token: nil, logprob: nil)
-            #   @param token [String] A possible text token.
+            #   @param token [String]
+            #     A possible text token.
             #
-            #   @param logprob [Float] The log probability of this token.
+            #   @param logprob [Float]
+            #     The log probability of this token.
           end
         end
 
@@ -144,7 +149,8 @@ module OpenAI
           # @!method initialize(agent_name:)
           #   The agent that owns this multi-agent streaming event.
           #
-          #   @param agent_name [String] The canonical name of the agent that produced this item.
+          #   @param agent_name [String]
+          #     The canonical name of the agent that produced this item.
         end
       end
     end