openai 0.87.0 → 0.88.0

data/lib/openai/models/responses/response_steer_input.rb

@@ -70,15 +70,20 @@ module OpenAI
             optional :status, String, nil?: true
 
             # @!method initialize(content:, id: nil, status: nil, role: :user, type: :message)
-            #   @param content [Array<OpenAI::Models::Responses::ResponseInputTextContent, OpenAI::Models::Responses::ResponseInputImageContent, OpenAI::Models::Responses::ResponseInputFileContent>, String] The message content, as an array of content parts.
+            #   @param content [Array<OpenAI::Models::Responses::ResponseInputTextContent, OpenAI::Models::Responses::ResponseInputImageContent, OpenAI::Models::Responses::ResponseInputFileContent>, 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 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.
             #
@@ -175,27 +180,33 @@ module OpenAI
             )
 
             # @!method initialize(output:, id: 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::Responses::ResponseSteerInput::ResponseSteerInputItemList::FunctionCallOutput}
-            #   for more details.
-            #
             #   The output of a function tool call.
             #
-            #   @param output [String, Array<OpenAI::Models::Responses::ResponseInputTextContent, OpenAI::Models::Responses::ResponseInputImageContent, OpenAI::Models::Responses::ResponseInputFileContent>] Text, image, or file output of the function tool call.
+            #   @param output [String, Array<OpenAI::Models::Responses::ResponseInputTextContent, OpenAI::Models::Responses::ResponseInputImageContent, OpenAI::Models::Responses::ResponseInputFileContent>]
+            #     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 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::Responses::ResponseSteerInput::ResponseSteerInputItemList::FunctionCallOutput::Caller::Direct, OpenAI::Models::Responses::ResponseSteerInput::ResponseSteerInputItemList::FunctionCallOutput::Caller::Program, nil] The execution context that produced this tool call.
+            #   @param caller_ [OpenAI::Models::Responses::ResponseSteerInput::ResponseSteerInputItemList::FunctionCallOutput::Caller::Direct, OpenAI::Models::Responses::ResponseSteerInput::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::Responses::ResponseSteerInput::ResponseSteerInputItemList::FunctionCallOutput::Status, nil] The status of the item. One of `in_progress`, `completed`, or `incomplete`. Popu
+            #   @param status [Symbol, OpenAI::Models::Responses::ResponseSteerInput::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.
             #
@@ -243,7 +254,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
@@ -260,9 +272,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/responses/response_steer_input_content.rb

@@ -12,7 +12,7 @@ module OpenAI
         # A text input to the model.
         variant :input_text, -> { OpenAI::Responses::ResponseInputTextContent }
 
-        # 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::Responses::ResponseInputImageContent }
 
         # A file input to the model.

data/lib/openai/models/responses/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::Responses::ResponseSteerPendingEvent} 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::Responses::ResponseSteerRequiredInput::FunctionCallOutput, OpenAI::Models::Responses::ResponseSteerRequiredInput::CustomToolCallOutput, OpenAI::Models::Responses::ResponseSteerRequiredInput::ComputerCallOutput, OpenAI::Models::Responses::ResponseSteerRequiredInput::ShellCallOutput, OpenAI::Models::Responses::ResponseSteerRequiredInput::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseSteerRequiredInput::ToolSearchOutput, OpenAI::Models::Responses::ResponseSteerRequiredInput::McpApprovalResponse>] Input stubs identifying outstanding client-owned tool results or
+        #   @param required_input [Array<OpenAI::Models::Responses::ResponseSteerRequiredInput::FunctionCallOutput, OpenAI::Models::Responses::ResponseSteerRequiredInput::CustomToolCallOutput, OpenAI::Models::Responses::ResponseSteerRequiredInput::ComputerCallOutput, OpenAI::Models::Responses::ResponseSteerRequiredInput::ShellCallOutput, OpenAI::Models::Responses::ResponseSteerRequiredInput::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseSteerRequiredInput::ToolSearchOutput, OpenAI::Models::Responses::ResponseSteerRequiredInput::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::Responses::ResponseSteerPendingEvent::Steer] The steering submission that remains queued.
+        #   @param steer [OpenAI::Models::Responses::ResponseSteerPendingEvent::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::Responses::ResponseSteerPendingEvent#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/responses/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::Responses::ResponseTextConfig::Verbosity }, nil?: true
 
         # @!method initialize(format_: nil, verbosity: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseTextConfig} 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::ResponseFormatText, OpenAI::Models::Responses::ResponseFormatTextJSONSchemaConfig, OpenAI::Models::ResponseFormatJSONObject]
+        #     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::ResponseFormatText, OpenAI::Models::Responses::ResponseFormatTextJSONSchemaConfig, OpenAI::Models::ResponseFormatJSONObject] 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::Responses::ResponseTextConfig::Verbosity, nil] Constrains the verbosity of the model's response. Lower values will result in
+        #   @param verbosity [Symbol, OpenAI::Models::Responses::ResponseTextConfig::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/responses/response_text_delta_event.rb

@@ -50,25 +50,28 @@ module OpenAI
         required :type, const: :"response.output_text.delta"
 
         # @!method initialize(content_index:, delta:, item_id:, logprobs:, output_index:, sequence_number:, type: :"response.output_text.delta")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseTextDeltaEvent} 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::Responses::ResponseTextDeltaEvent::Logprob>] The log probabilities of the tokens in the delta.
+        #   @param logprobs [Array<OpenAI::Models::Responses::ResponseTextDeltaEvent::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 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.
@@ -92,19 +95,18 @@ module OpenAI
           )
 
           # @!method initialize(token:, logprob:, top_logprobs: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Responses::ResponseTextDeltaEvent::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::Responses::ResponseTextDeltaEvent::Logprob::TopLogprob>] The log probabilities of up to 20 of the most likely tokens.
-
+          #   @param top_logprobs [Array<OpenAI::Models::Responses::ResponseTextDeltaEvent::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.
@@ -119,9 +121,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
       end

data/lib/openai/models/responses/response_text_done_event.rb

@@ -50,25 +50,28 @@ module OpenAI
         required :type, const: :"response.output_text.done"
 
         # @!method initialize(content_index:, item_id:, logprobs:, output_index:, sequence_number:, text:, type: :"response.output_text.done")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseTextDoneEvent} for more details.
-        #
         #   Emitted when text content is finalized.
         #
-        #   @param content_index [Integer] The index of the content part that the text content is finalized.
+        #   @param content_index [Integer]
+        #     The index of the content part that the text content is finalized.
         #
-        #   @param item_id [String] The ID of the output item that the text content is finalized.
+        #   @param item_id [String]
+        #     The ID of the output item that the text content is finalized.
         #
-        #   @param logprobs [Array<OpenAI::Models::Responses::ResponseTextDoneEvent::Logprob>] The log probabilities of the tokens in the delta.
+        #   @param logprobs [Array<OpenAI::Models::Responses::ResponseTextDoneEvent::Logprob>]
+        #     The log probabilities of the tokens in the delta.
         #
-        #   @param output_index [Integer] The index of the output item that the text content is finalized.
+        #   @param output_index [Integer]
+        #     The index of the output item that the text content is finalized.
         #
-        #   @param sequence_number [Integer] The sequence number for this event.
+        #   @param sequence_number [Integer]
+        #     The sequence number for this event.
         #
-        #   @param text [String] The text content that is finalized.
+        #   @param text [String]
+        #     The text content that is finalized.
         #
-        #   @param type [Symbol, :"response.output_text.done"] The type of the event. Always `response.output_text.done`.
-
+        #   @param type [Symbol, :"response.output_text.done"]
+        #     The type of the event. Always `response.output_text.done`.
         class Logprob < OpenAI::Internal::Type::BaseModel
           # @!attribute token
           #   A possible text token.
@@ -92,19 +95,18 @@ module OpenAI
           )
 
           # @!method initialize(token:, logprob:, top_logprobs: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Responses::ResponseTextDoneEvent::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::Responses::ResponseTextDoneEvent::Logprob::TopLogprob>] The log probabilities of up to 20 of the most likely tokens.
-
+          #   @param top_logprobs [Array<OpenAI::Models::Responses::ResponseTextDoneEvent::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.
@@ -119,9 +121,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
       end

data/lib/openai/models/responses/response_tool_search_call.rb

@@ -47,19 +47,26 @@ module OpenAI
         optional :created_by, String
 
         # @!method initialize(id:, arguments:, call_id:, execution:, status:, created_by: nil, type: :tool_search_call)
-        #   @param id [String] The unique ID of the tool search call item.
+        #   @param id [String]
+        #     The unique ID of the tool search call item.
         #
-        #   @param arguments [Object] Arguments used for the tool search call.
+        #   @param arguments [Object]
+        #     Arguments used for the tool search call.
         #
-        #   @param call_id [String, nil] The unique ID of the tool search call generated by the model.
+        #   @param call_id [String, nil]
+        #     The unique ID of the tool search call generated by the model.
         #
-        #   @param execution [Symbol, OpenAI::Models::Responses::ResponseToolSearchCall::Execution] Whether tool search was executed by the server or by the client.
+        #   @param execution [Symbol, OpenAI::Models::Responses::ResponseToolSearchCall::Execution]
+        #     Whether tool search was executed by the server or by the client.
         #
-        #   @param status [Symbol, OpenAI::Models::Responses::ResponseToolSearchCall::Status] The status of the tool search call item that was recorded.
+        #   @param status [Symbol, OpenAI::Models::Responses::ResponseToolSearchCall::Status]
+        #     The status of the tool search call item that was recorded.
         #
-        #   @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.
         #
-        #   @param type [Symbol, :tool_search_call] The type of the item. Always `tool_search_call`.
+        #   @param type [Symbol, :tool_search_call]
+        #     The type of the item. Always `tool_search_call`.
 
         # Whether tool search was executed by the server or by the client.
         #

data/lib/openai/models/responses/response_tool_search_output_item.rb

@@ -47,19 +47,26 @@ module OpenAI
         optional :created_by, String
 
         # @!method initialize(id:, call_id:, execution:, status:, tools:, created_by: nil, type: :tool_search_output)
-        #   @param id [String] The unique ID of the tool search output item.
+        #   @param id [String]
+        #     The unique ID of the tool search output item.
         #
-        #   @param call_id [String, nil] The unique ID of the tool search call generated by the model.
+        #   @param call_id [String, nil]
+        #     The unique ID of the tool search call generated by the model.
         #
-        #   @param execution [Symbol, OpenAI::Models::Responses::ResponseToolSearchOutputItem::Execution] Whether tool search was executed by the server or by the client.
+        #   @param execution [Symbol, OpenAI::Models::Responses::ResponseToolSearchOutputItem::Execution]
+        #     Whether tool search was executed by the server or by the client.
         #
-        #   @param status [Symbol, OpenAI::Models::Responses::ResponseToolSearchOutputItem::Status] The status of the tool search output item that was recorded.
+        #   @param status [Symbol, OpenAI::Models::Responses::ResponseToolSearchOutputItem::Status]
+        #     The status of the tool search output item that was recorded.
         #
-        #   @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ProgrammaticToolCalling, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>] The loaded tool definitions returned by tool search.
+        #   @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ProgrammaticToolCalling, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>]
+        #     The loaded tool definitions returned by tool search.
         #
-        #   @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.
         #
-        #   @param type [Symbol, :tool_search_output] The type of the item. Always `tool_search_output`.
+        #   @param type [Symbol, :tool_search_output]
+        #     The type of the item. Always `tool_search_output`.
 
         # Whether tool search was executed by the server or by the client.
         #

data/lib/openai/models/responses/response_tool_search_output_item_param.rb

@@ -47,17 +47,23 @@ module OpenAI
         )
 
         # @!method initialize(tools:, id: nil, call_id: nil, execution: nil, status: nil, type: :tool_search_output)
-        #   @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ProgrammaticToolCalling, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>] The loaded tool definitions returned by the tool search output.
+        #   @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ProgrammaticToolCalling, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>]
+        #     The loaded tool definitions returned by the tool search output.
         #
-        #   @param id [String, nil] The unique ID of this tool search output.
+        #   @param id [String, nil]
+        #     The unique ID of this tool search output.
         #
-        #   @param call_id [String, nil] The unique ID of the tool search call generated by the model.
+        #   @param call_id [String, nil]
+        #     The unique ID of the tool search call generated by the model.
         #
-        #   @param execution [Symbol, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam::Execution] Whether tool search was executed by the server or by the client.
+        #   @param execution [Symbol, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam::Execution]
+        #     Whether tool search was executed by the server or by the client.
         #
-        #   @param status [Symbol, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam::Status, nil] The status of the tool search output.
+        #   @param status [Symbol, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam::Status, nil]
+        #     The status of the tool search output.
         #
-        #   @param type [Symbol, :tool_search_output] The item type. Always `tool_search_output`.
+        #   @param type [Symbol, :tool_search_output]
+        #     The item type. Always `tool_search_output`.
 
         # Whether tool search was executed by the server or by the client.
         #

data/lib/openai/models/responses/response_usage.rb

@@ -38,15 +38,20 @@ module OpenAI
         #   Represents token usage details including input tokens, output tokens, a
         #   breakdown of output tokens, and the total tokens used.
         #
-        #   @param input_tokens [Integer] The number of input tokens.
+        #   @param input_tokens [Integer]
+        #     The number of input tokens.
         #
-        #   @param input_tokens_details [OpenAI::Models::Responses::ResponseUsage::InputTokensDetails] A detailed breakdown of the input tokens.
+        #   @param input_tokens_details [OpenAI::Models::Responses::ResponseUsage::InputTokensDetails]
+        #     A detailed breakdown of the input tokens.
         #
-        #   @param output_tokens [Integer] The number of output tokens.
+        #   @param output_tokens [Integer]
+        #     The number of output tokens.
         #
-        #   @param output_tokens_details [OpenAI::Models::Responses::ResponseUsage::OutputTokensDetails] A detailed breakdown of the output tokens.
+        #   @param output_tokens_details [OpenAI::Models::Responses::ResponseUsage::OutputTokensDetails]
+        #     A detailed breakdown of the output tokens.
         #
-        #   @param total_tokens [Integer] The total number of tokens used.
+        #   @param total_tokens [Integer]
+        #     The total number of tokens used.
 
         # @see OpenAI::Models::Responses::ResponseUsage#input_tokens_details
         class InputTokensDetails < OpenAI::Internal::Type::BaseModel
@@ -58,20 +63,20 @@ module OpenAI
 
           # @!attribute cached_tokens
           #   The number of tokens that were retrieved from the cache.
-          #   [More on prompt caching](https://platform.openai.com/docs/guides/prompt-caching).
+          #   [More on prompt caching](https://developers.openai.com/api/docs/guides/prompt-caching).
           #
           #   @return [Integer]
           required :cached_tokens, Integer
 
           # @!method initialize(cache_write_tokens:, cached_tokens:)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Responses::ResponseUsage::InputTokensDetails} for more details.
-          #
           #   A detailed breakdown of the input tokens.
           #
-          #   @param cache_write_tokens [Integer] The number of input tokens that were written to the cache.
+          #   @param cache_write_tokens [Integer]
+          #     The number of input tokens that were written to the cache.
           #
-          #   @param cached_tokens [Integer] The number of tokens that were retrieved from the cache.
+          #   @param cached_tokens [Integer]
+          #     The number of tokens that were retrieved from the cache.
+          #     [More on prompt caching](https://developers.openai.com/api/docs/guides/prompt-caching).
         end
 
         # @see OpenAI::Models::Responses::ResponseUsage#output_tokens_details
@@ -85,7 +90,8 @@ module OpenAI
           # @!method initialize(reasoning_tokens:)
           #   A detailed breakdown of the output tokens.
           #
-          #   @param reasoning_tokens [Integer] The number of reasoning tokens.
+          #   @param reasoning_tokens [Integer]
+          #     The number of reasoning tokens.
         end
       end
     end

data/lib/openai/models/responses/response_web_search_call_completed_event.rb

@@ -29,19 +29,19 @@ module OpenAI
         required :type, const: :"response.web_search_call.completed"
 
         # @!method initialize(item_id:, output_index:, sequence_number:, type: :"response.web_search_call.completed")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseWebSearchCallCompletedEvent} for more
-        #   details.
-        #
         #   Emitted when a web search call is completed.
         #
-        #   @param item_id [String] Unique ID for the output item associated with the web search call.
+        #   @param item_id [String]
+        #     Unique ID for the output item associated with the web search call.
         #
-        #   @param output_index [Integer] The index of the output item that the web search call is associated with.
+        #   @param output_index [Integer]
+        #     The index of the output item that the web search call is associated with.
         #
-        #   @param sequence_number [Integer] The sequence number of the web search call being processed.
+        #   @param sequence_number [Integer]
+        #     The sequence number of the web search call being processed.
         #
-        #   @param type [Symbol, :"response.web_search_call.completed"] The type of the event. Always `response.web_search_call.completed`.
+        #   @param type [Symbol, :"response.web_search_call.completed"]
+        #     The type of the event. Always `response.web_search_call.completed`.
       end
     end
   end

data/lib/openai/models/responses/response_web_search_call_in_progress_event.rb

@@ -29,19 +29,19 @@ module OpenAI
         required :type, const: :"response.web_search_call.in_progress"
 
         # @!method initialize(item_id:, output_index:, sequence_number:, type: :"response.web_search_call.in_progress")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseWebSearchCallInProgressEvent} for more
-        #   details.
-        #
         #   Emitted when a web search call is initiated.
         #
-        #   @param item_id [String] Unique ID for the output item associated with the web search call.
+        #   @param item_id [String]
+        #     Unique ID for the output item associated with the web search call.
         #
-        #   @param output_index [Integer] The index of the output item that the web search call is associated with.
+        #   @param output_index [Integer]
+        #     The index of the output item that the web search call is associated with.
         #
-        #   @param sequence_number [Integer] The sequence number of the web search call being processed.
+        #   @param sequence_number [Integer]
+        #     The sequence number of the web search call being processed.
         #
-        #   @param type [Symbol, :"response.web_search_call.in_progress"] The type of the event. Always `response.web_search_call.in_progress`.
+        #   @param type [Symbol, :"response.web_search_call.in_progress"]
+        #     The type of the event. Always `response.web_search_call.in_progress`.
       end
     end
   end

data/lib/openai/models/responses/response_web_search_call_searching_event.rb

@@ -29,19 +29,19 @@ module OpenAI
         required :type, const: :"response.web_search_call.searching"
 
         # @!method initialize(item_id:, output_index:, sequence_number:, type: :"response.web_search_call.searching")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseWebSearchCallSearchingEvent} for more
-        #   details.
-        #
         #   Emitted when a web search call is executing.
         #
-        #   @param item_id [String] Unique ID for the output item associated with the web search call.
+        #   @param item_id [String]
+        #     Unique ID for the output item associated with the web search call.
         #
-        #   @param output_index [Integer] The index of the output item that the web search call is associated with.
+        #   @param output_index [Integer]
+        #     The index of the output item that the web search call is associated with.
         #
-        #   @param sequence_number [Integer] The sequence number of the web search call being processed.
+        #   @param sequence_number [Integer]
+        #     The sequence number of the web search call being processed.
         #
-        #   @param type [Symbol, :"response.web_search_call.searching"] The type of the event. Always `response.web_search_call.searching`.
+        #   @param type [Symbol, :"response.web_search_call.searching"]
+        #     The type of the event. Always `response.web_search_call.searching`.
       end
     end
   end