openai 0.87.0 → 0.88.0

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

@@ -23,16 +23,16 @@ module OpenAI
         required :type, const: :"response.created"
 
         # @!method initialize(response:, sequence_number:, type: :"response.created")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseCreatedEvent} for more details.
-        #
         #   An event that is emitted when a response is created.
         #
-        #   @param response [OpenAI::Models::Responses::Response] The response that was created.
+        #   @param response [OpenAI::Models::Responses::Response]
+        #     The response that was created.
         #
-        #   @param sequence_number [Integer] The sequence number for this event.
+        #   @param sequence_number [Integer]
+        #     The sequence number for this event.
         #
-        #   @param type [Symbol, :"response.created"] The type of the event. Always `response.created`.
+        #   @param type [Symbol, :"response.created"]
+        #     The type of the event. Always `response.created`.
       end
     end
   end

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

@@ -58,26 +58,31 @@ module OpenAI
         optional :namespace, String
 
         # @!method initialize(call_id:, input:, name:, id: nil, async: nil, caller_: nil, namespace: nil, type: :custom_tool_call)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseCustomToolCall} for more details.
-        #
         #   A call to a custom tool created by the model.
         #
-        #   @param call_id [String] An identifier used to map this custom tool call to a tool call output.
+        #   @param call_id [String]
+        #     An identifier used to map this custom tool call to a tool call output.
         #
-        #   @param input [String] The input for the custom tool call generated by the model.
+        #   @param input [String]
+        #     The input for the custom tool call generated by the model.
         #
-        #   @param name [String] The name of the custom tool being called.
+        #   @param name [String]
+        #     The name of the custom tool being called.
         #
-        #   @param id [String] The unique ID of the custom tool call in the OpenAI platform.
+        #   @param id [String]
+        #     The unique ID of the custom tool call in the OpenAI platform.
         #
-        #   @param async [Boolean] Whether the custom tool call runs asynchronously.
+        #   @param async [Boolean]
+        #     Whether the custom tool call runs asynchronously.
         #
-        #   @param caller_ [OpenAI::Models::Responses::ResponseCustomToolCall::Caller::Direct, OpenAI::Models::Responses::ResponseCustomToolCall::Caller::Program, nil] The execution context that produced this tool call.
+        #   @param caller_ [OpenAI::Models::Responses::ResponseCustomToolCall::Caller::Direct, OpenAI::Models::Responses::ResponseCustomToolCall::Caller::Program, nil]
+        #     The execution context that produced this tool call.
         #
-        #   @param namespace [String] The namespace of the custom tool being called.
+        #   @param namespace [String]
+        #     The namespace of the custom tool being called.
         #
-        #   @param type [Symbol, :custom_tool_call] The type of the custom tool call. Always `custom_tool_call`.
+        #   @param type [Symbol, :custom_tool_call]
+        #     The type of the custom tool call. Always `custom_tool_call`.
 
         # The execution context that produced this tool call.
         #
@@ -114,7 +119,8 @@ 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]
           end

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

@@ -37,15 +37,20 @@ module OpenAI
         # @!method initialize(delta:, item_id:, output_index:, sequence_number:, type: :"response.custom_tool_call_input.delta")
         #   Event representing a delta (partial update) to the input of a custom tool call.
         #
-        #   @param delta [String] The incremental input data (delta) for the custom tool call.
+        #   @param delta [String]
+        #     The incremental input data (delta) for the custom tool call.
         #
-        #   @param item_id [String] Unique identifier for the API item associated with this event.
+        #   @param item_id [String]
+        #     Unique identifier for the API item associated with this event.
         #
-        #   @param output_index [Integer] The index of the output this delta applies to.
+        #   @param output_index [Integer]
+        #     The index of the output this delta applies to.
         #
-        #   @param sequence_number [Integer] The sequence number of this event.
+        #   @param sequence_number [Integer]
+        #     The sequence number of this event.
         #
-        #   @param type [Symbol, :"response.custom_tool_call_input.delta"] The event type identifier.
+        #   @param type [Symbol, :"response.custom_tool_call_input.delta"]
+        #     The event type identifier.
       end
     end
   end

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

@@ -37,15 +37,20 @@ module OpenAI
         # @!method initialize(input:, item_id:, output_index:, sequence_number:, type: :"response.custom_tool_call_input.done")
         #   Event indicating that input for a custom tool call is complete.
         #
-        #   @param input [String] The complete input data for the custom tool call.
+        #   @param input [String]
+        #     The complete input data for the custom tool call.
         #
-        #   @param item_id [String] Unique identifier for the API item associated with this event.
+        #   @param item_id [String]
+        #     Unique identifier for the API item associated with this event.
         #
-        #   @param output_index [Integer] The index of the output this event applies to.
+        #   @param output_index [Integer]
+        #     The index of the output this event applies to.
         #
-        #   @param sequence_number [Integer] The sequence number of this event.
+        #   @param sequence_number [Integer]
+        #     The sequence number of this event.
         #
-        #   @param type [Symbol, :"response.custom_tool_call_input.done"] The event type identifier.
+        #   @param type [Symbol, :"response.custom_tool_call_input.done"]
+        #     The event type identifier.
       end
     end
   end

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

@@ -24,30 +24,38 @@ module OpenAI
         optional :created_by, String
 
         # @!method initialize(call_id:, input:, name:, id:, status:, async: nil, caller_: nil, namespace: nil, created_by: nil, type: :custom_tool_call)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseCustomToolCallItem} for more details.
-        #
         #   A call to a custom tool created by the model.
         #
-        #   @param call_id [String] An identifier used to map this custom tool call to a tool call output.
+        #   @param call_id [String]
+        #     An identifier used to map this custom tool call to a tool call output.
         #
-        #   @param input [String] The input for the custom tool call generated by the model.
+        #   @param input [String]
+        #     The input for the custom tool call generated by the model.
         #
-        #   @param name [String] The name of the custom tool being called.
+        #   @param name [String]
+        #     The name of the custom tool being called.
         #
-        #   @param id [String] The unique ID of the custom tool call item.
+        #   @param id [String]
+        #     The unique ID of the custom tool call item.
         #
-        #   @param status [Symbol, OpenAI::Models::Responses::ResponseCustomToolCallItem::Status] The status of the item. One of `in_progress`, `completed`, or
+        #   @param status [Symbol, OpenAI::Models::Responses::ResponseCustomToolCallItem::Status]
+        #     The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+        #     Populated when items are returned via API.
         #
-        #   @param async [Boolean] Whether the custom tool call runs asynchronously.
+        #   @param async [Boolean]
+        #     Whether the custom tool call runs asynchronously.
         #
-        #   @param caller_ [OpenAI::Models::Responses::ResponseCustomToolCall::Caller::Direct, OpenAI::Models::Responses::ResponseCustomToolCall::Caller::Program, nil] The execution context that produced this tool call.
+        #   @param caller_ [OpenAI::Models::Responses::ResponseCustomToolCall::Caller::Direct, OpenAI::Models::Responses::ResponseCustomToolCall::Caller::Program, nil]
+        #     The execution context that produced this tool call.
         #
-        #   @param namespace [String] The namespace of the custom tool being called.
+        #   @param namespace [String]
+        #     The namespace of the custom tool being called.
         #
-        #   @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, :custom_tool_call] The type of the custom tool call. Always `custom_tool_call`.
+        #   @param type [Symbol, :custom_tool_call]
+        #     The type of the custom tool call. Always `custom_tool_call`.
 
         # The status of the item. One of `in_progress`, `completed`, or `incomplete`.
         # Populated when items are returned via API.

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

@@ -41,20 +41,23 @@ module OpenAI
         )
 
         # @!method initialize(call_id:, output:, id: nil, caller_: nil, type: :custom_tool_call_output)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseCustomToolCallOutput} for more details.
-        #
         #   The output of a custom tool call from your code, being sent back to the model.
         #
-        #   @param call_id [String] The call ID, used to map this custom tool call output to a custom tool call.
+        #   @param call_id [String]
+        #     The call ID, used to map this custom tool call output to a custom tool call.
         #
-        #   @param output [String, Array<OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Responses::ResponseInputImage, OpenAI::Models::Responses::ResponseInputFile>] The output from the custom tool call generated by your code.
+        #   @param output [String, Array<OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Responses::ResponseInputImage, OpenAI::Models::Responses::ResponseInputFile>]
+        #     The output from the custom tool call generated by your code. Can be a string or
+        #     an list of output content.
         #
-        #   @param id [String] The unique ID of the custom tool call output in the OpenAI platform.
+        #   @param id [String]
+        #     The unique ID of the custom tool call output in the OpenAI platform.
         #
-        #   @param caller_ [OpenAI::Models::Responses::ResponseCustomToolCallOutput::Caller::Direct, OpenAI::Models::Responses::ResponseCustomToolCallOutput::Caller::Program, nil] The execution context that produced this tool call.
+        #   @param caller_ [OpenAI::Models::Responses::ResponseCustomToolCallOutput::Caller::Direct, OpenAI::Models::Responses::ResponseCustomToolCallOutput::Caller::Program, nil]
+        #     The execution context that produced this tool call.
         #
-        #   @param type [Symbol, :custom_tool_call_output] The type of the custom tool call output. Always `custom_tool_call_output`.
+        #   @param type [Symbol, :custom_tool_call_output]
+        #     The type of the custom tool call output. Always `custom_tool_call_output`.
 
         # The output from the custom tool call generated by your code. Can be a string or
         # an list of output content.
@@ -78,7 +81,7 @@ module OpenAI
             # A text input to the model.
             variant :input_text, -> { OpenAI::Responses::ResponseInputText }
 
-            # 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::ResponseInputImage }
 
             # A file input to the model.
@@ -119,7 +122,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
@@ -136,9 +140,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_custom_tool_call_output_item.rb

@@ -24,24 +24,30 @@ module OpenAI
         optional :created_by, String
 
         # @!method initialize(call_id:, output:, id:, status:, caller_: nil, created_by: nil, type: :custom_tool_call_output)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseCustomToolCallOutputItem} for more details.
-        #
         #   The output of a custom tool call from your code, being sent back to the model.
         #
-        #   @param call_id [String] The call ID, used to map this custom tool call output to a custom tool call.
+        #   @param call_id [String]
+        #     The call ID, used to map this custom tool call output to a custom tool call.
         #
-        #   @param output [String, Array<OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Responses::ResponseInputImage, OpenAI::Models::Responses::ResponseInputFile>] The output from the custom tool call generated by your code.
+        #   @param output [String, Array<OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Responses::ResponseInputImage, OpenAI::Models::Responses::ResponseInputFile>]
+        #     The output from the custom tool call generated by your code. Can be a string or
+        #     an list of output content.
         #
-        #   @param id [String] The unique ID of the custom tool call output item.
+        #   @param id [String]
+        #     The unique ID of the custom tool call output item.
         #
-        #   @param status [Symbol, OpenAI::Models::Responses::ResponseCustomToolCallOutputItem::Status] The status of the item. One of `in_progress`, `completed`, or
+        #   @param status [Symbol, OpenAI::Models::Responses::ResponseCustomToolCallOutputItem::Status]
+        #     The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+        #     Populated when items are returned via API.
         #
-        #   @param caller_ [OpenAI::Models::Responses::ResponseCustomToolCallOutput::Caller::Direct, OpenAI::Models::Responses::ResponseCustomToolCallOutput::Caller::Program, nil] The execution context that produced this tool call.
+        #   @param caller_ [OpenAI::Models::Responses::ResponseCustomToolCallOutput::Caller::Direct, OpenAI::Models::Responses::ResponseCustomToolCallOutput::Caller::Program, nil]
+        #     The execution context that produced this tool call.
         #
-        #   @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, :custom_tool_call_output] The type of the custom tool call output. Always `custom_tool_call_output`.
+        #   @param type [Symbol, :custom_tool_call_output]
+        #     The type of the custom tool call output. Always `custom_tool_call_output`.
 
         # The status of the item. One of `in_progress`, `completed`, or `incomplete`.
         # Populated when items are returned via API.

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

@@ -22,14 +22,13 @@ module OpenAI
         optional :misalignment, -> { OpenAI::Responses::ResponseError::Misalignment }
 
         # @!method initialize(code:, message:, misalignment: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseError} for more details.
-        #
         #   An error object returned when the model fails to generate a Response.
         #
-        #   @param code [Symbol, OpenAI::Models::Responses::ResponseError::Code] The error code for the response.
+        #   @param code [Symbol, OpenAI::Models::Responses::ResponseError::Code]
+        #     The error code for the response.
         #
-        #   @param message [String] A human-readable description of the error.
+        #   @param message [String]
+        #     A human-readable description of the error.
         #
         #   @param misalignment [OpenAI::Models::Responses::ResponseError::Misalignment]
 
@@ -86,11 +85,14 @@ module OpenAI
           optional :steer, -> { OpenAI::Responses::ResponseError::Misalignment::Steer }
 
           # @!method initialize(detailed_explanation: nil, error_type: nil, steer: nil)
-          #   @param detailed_explanation [String] The public explanation for this block.
+          #   @param detailed_explanation [String]
+          #     The public explanation for this block.
           #
-          #   @param error_type [String, Symbol, OpenAI::Models::Responses::ResponseError::Misalignment::ErrorType] An optional classification; clients must accept additional values.
+          #   @param error_type [String, Symbol, OpenAI::Models::Responses::ResponseError::Misalignment::ErrorType]
+          #     An optional classification; clients must accept additional values.
           #
-          #   @param steer [OpenAI::Models::Responses::ResponseError::Misalignment::Steer] An optional public continuation instruction.
+          #   @param steer [OpenAI::Models::Responses::ResponseError::Misalignment::Steer]
+          #     An optional public continuation instruction.
 
           # An optional classification; clients must accept additional values.
           #
@@ -148,7 +150,8 @@ module OpenAI
             # @!method initialize(message:)
             #   An optional public continuation instruction.
             #
-            #   @param message [String] The public continuation instruction.
+            #   @param message [String]
+            #     The public continuation instruction.
           end
         end
       end

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

@@ -35,20 +35,22 @@ module OpenAI
         required :type, const: :error
 
         # @!method initialize(code:, message:, param:, sequence_number:, type: :error)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseErrorEvent} for more details.
-        #
         #   Emitted when an error occurs.
         #
-        #   @param code [String, nil] The error code.
+        #   @param code [String, nil]
+        #     The error code.
         #
-        #   @param message [String] The error message.
+        #   @param message [String]
+        #     The error message.
         #
-        #   @param param [String, nil] The error parameter.
+        #   @param param [String, nil]
+        #     The error parameter.
         #
-        #   @param sequence_number [Integer] The sequence number of this event.
+        #   @param sequence_number [Integer]
+        #     The sequence number of this event.
         #
-        #   @param type [Symbol, :error] The type of the event. Always `error`.
+        #   @param type [Symbol, :error]
+        #     The type of the event. Always `error`.
       end
     end
   end

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

@@ -23,16 +23,16 @@ module OpenAI
         required :type, const: :"response.failed"
 
         # @!method initialize(response:, sequence_number:, type: :"response.failed")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseFailedEvent} for more details.
-        #
         #   An event that is emitted when a response fails.
         #
-        #   @param response [OpenAI::Models::Responses::Response] The response that failed.
+        #   @param response [OpenAI::Models::Responses::Response]
+        #     The response that failed.
         #
-        #   @param sequence_number [Integer] The sequence number of this event.
+        #   @param sequence_number [Integer]
+        #     The sequence number of this event.
         #
-        #   @param type [Symbol, :"response.failed"] The type of the event. Always `response.failed`.
+        #   @param type [Symbol, :"response.failed"]
+        #     The type of the event. Always `response.failed`.
       end
     end
   end

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

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

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

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

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

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

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

@@ -42,22 +42,25 @@ module OpenAI
         )
 
         # @!method initialize(id:, queries:, status:, results: nil, type: :file_search_call)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseFileSearchToolCall} for more details.
-        #
         #   The results of a file search tool call. See the
-        #   [file search guide](https://platform.openai.com/docs/guides/tools-file-search)
+        #   [file search guide](https://developers.openai.com/api/docs/guides/tools-file-search)
         #   for more information.
         #
-        #   @param id [String] The unique ID of the file search tool call.
+        #   @param id [String]
+        #     The unique ID of the file search tool call.
         #
-        #   @param queries [Array<String>] The queries used to search for files.
+        #   @param queries [Array<String>]
+        #     The queries used to search for files.
         #
-        #   @param status [Symbol, OpenAI::Models::Responses::ResponseFileSearchToolCall::Status] The status of the file search tool call. One of `in_progress`,
+        #   @param status [Symbol, OpenAI::Models::Responses::ResponseFileSearchToolCall::Status]
+        #     The status of the file search tool call. One of `in_progress`, `searching`,
+        #     `incomplete` or `failed`,
         #
-        #   @param results [Array<OpenAI::Models::Responses::ResponseFileSearchToolCall::Result>, nil] The results of the file search tool call.
+        #   @param results [Array<OpenAI::Models::Responses::ResponseFileSearchToolCall::Result>, nil]
+        #     The results of the file search tool call.
         #
-        #   @param type [Symbol, :file_search_call] The type of the file search tool call. Always `file_search_call`.
+        #   @param type [Symbol, :file_search_call]
+        #     The type of the file search tool call. Always `file_search_call`.
 
         # The status of the file search tool call. One of `in_progress`, `searching`,
         # `incomplete` or `failed`,
@@ -118,20 +121,24 @@ module OpenAI
           optional :text, String
 
           # @!method initialize(attributes: nil, file_id: nil, filename: nil, score: nil, text: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Responses::ResponseFileSearchToolCall::Result} for more
-          #   details.
-          #
-          #   @param attributes [Hash{Symbol=>String, Float, Boolean}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
+          #   @param attributes [Hash{Symbol=>String, Float, Boolean}, nil]
+          #     Set of 16 key-value pairs that can be attached to an object. This can be useful
+          #     for storing additional information about the object in a structured format, and
+          #     querying for objects via API or the dashboard. Keys are strings with a maximum
+          #     length of 64 characters. Values are strings with a maximum length of 512
+          #     characters, booleans, or numbers.
           #
-          #   @param file_id [String] The unique ID of the file.
+          #   @param file_id [String]
+          #     The unique ID of the file.
           #
-          #   @param filename [String] The name of the file.
+          #   @param filename [String]
+          #     The name of the file.
           #
-          #   @param score [Float] The relevance score of the file - a value between 0 and 1.
+          #   @param score [Float]
+          #     The relevance score of the file - a value between 0 and 1.
           #
-          #   @param text [String] The text that was retrieved from the file.
-
+          #   @param text [String]
+          #     The text that was retrieved from the file.
           module Attribute
             extend OpenAI::Internal::Type::Union
 

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

@@ -7,7 +7,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.
       #
@@ -25,7 +25,7 @@ module OpenAI
         variant :text, -> { OpenAI::ResponseFormatText }
 
         # JSON Schema response format. Used to generate structured JSON responses.
-        # Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs).
+        # Learn more about [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs).
         variant :json_schema, -> { OpenAI::Responses::ResponseFormatTextJSONSchemaConfig }
 
         # An {OpenAI::BaseModel} can be provided and implicitly converted into {OpenAI::Models::Responses::ResponseFormatTextJSONSchemaConfig}.

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

@@ -44,29 +44,37 @@ module OpenAI
         #   true, the model will always follow the exact schema defined in the `schema`
         #   field. Only a subset of JSON Schema is supported when `strict` is `true`. To
         #   learn more, read the
-        #   [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).
+        #   [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
         #
         #   @return [Boolean, nil]
         optional :strict, OpenAI::Internal::Type::Boolean, nil?: true
 
         # @!method initialize(name:, schema:, description: nil, strict: nil, type: :json_schema)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseFormatTextJSONSchemaConfig} for more
-        #   details.
-        #
         #   JSON Schema response format. Used to generate structured JSON responses. Learn
         #   more about
-        #   [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs).
+        #   [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs).
         #
-        #   @param name [String] The name of the response format. Must be a-z, A-Z, 0-9, or contain
+        #   @param name [String]
+        #     The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores
+        #     and dashes, with a maximum length of 64.
         #
-        #   @param schema [Hash{Symbol=>Object}, OpenAI::StructuredOutput::JsonSchemaConverter] The schema for the response format, described as a JSON Schema object.
+        #   @param schema [Hash{Symbol=>Object}, OpenAI::StructuredOutput::JsonSchemaConverter]
+        #     The schema for the response format, described as a JSON Schema object. Learn how
+        #     to build JSON schemas [here](https://json-schema.org/).
         #
-        #   @param description [String] A description of what the response format is for, used by the model to
+        #   @param description [String]
+        #     A description of what the response format is for, used by the model to determine
+        #     how to respond in the format.
         #
-        #   @param strict [Boolean, nil] Whether to enable strict schema adherence when generating the output.
+        #   @param strict [Boolean, nil]
+        #     Whether to enable strict schema adherence when generating the output. If set to
+        #     true, the model will always follow the exact schema defined in the `schema`
+        #     field. Only a subset of JSON Schema is supported when `strict` is `true`. To
+        #     learn more, read the
+        #     [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
         #
-        #   @param type [Symbol, :json_schema] The type of response format being defined. Always `json_schema`.
+        #   @param type [Symbol, :json_schema]
+        #     The type of response format being defined. Always `json_schema`.
       end
     end
   end