openai 0.86.0 → 0.88.0

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

@@ -54,24 +54,30 @@ module OpenAI
         optional :created_by, String
 
         # @!method initialize(id:, call_id:, operation:, status:, caller_: nil, created_by: nil, type: :apply_patch_call)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseApplyPatchToolCall} for more details.
-        #
         #   A tool call that applies file diffs by creating, deleting, or updating files.
         #
-        #   @param id [String] The unique ID of the apply patch tool call. Populated when this item is returned
+        #   @param id [String]
+        #     The unique ID of the apply patch tool call. Populated when this item is returned
+        #     via API.
         #
-        #   @param call_id [String] The unique ID of the apply patch tool call generated by the model.
+        #   @param call_id [String]
+        #     The unique ID of the apply patch tool call generated by the model.
         #
-        #   @param operation [OpenAI::Models::Responses::ResponseApplyPatchToolCall::Operation::CreateFile, OpenAI::Models::Responses::ResponseApplyPatchToolCall::Operation::DeleteFile, OpenAI::Models::Responses::ResponseApplyPatchToolCall::Operation::UpdateFile] One of the create_file, delete_file, or update_file operations applied via apply
+        #   @param operation [OpenAI::Models::Responses::ResponseApplyPatchToolCall::Operation::CreateFile, OpenAI::Models::Responses::ResponseApplyPatchToolCall::Operation::DeleteFile, OpenAI::Models::Responses::ResponseApplyPatchToolCall::Operation::UpdateFile]
+        #     One of the create_file, delete_file, or update_file operations applied via
+        #     apply_patch.
         #
-        #   @param status [Symbol, OpenAI::Models::Responses::ResponseApplyPatchToolCall::Status] The status of the apply patch tool call. One of `in_progress` or `completed`.
+        #   @param status [Symbol, OpenAI::Models::Responses::ResponseApplyPatchToolCall::Status]
+        #     The status of the apply patch tool call. One of `in_progress` or `completed`.
         #
-        #   @param caller_ [OpenAI::Models::Responses::ResponseApplyPatchToolCall::Caller::Direct, OpenAI::Models::Responses::ResponseApplyPatchToolCall::Caller::Program, nil] The execution context that produced this tool call.
+        #   @param caller_ [OpenAI::Models::Responses::ResponseApplyPatchToolCall::Caller::Direct, OpenAI::Models::Responses::ResponseApplyPatchToolCall::Caller::Program, nil]
+        #     The execution context that produced this tool call.
         #
-        #   @param created_by [String] The ID of the entity that created this tool call.
+        #   @param created_by [String]
+        #     The ID of the entity that created this tool call.
         #
-        #   @param type [Symbol, :apply_patch_call] The type of the item. Always `apply_patch_call`.
+        #   @param type [Symbol, :apply_patch_call]
+        #     The type of the item. Always `apply_patch_call`.
 
         # One of the create_file, delete_file, or update_file operations applied via
         # apply_patch.
@@ -113,11 +119,14 @@ module OpenAI
             # @!method initialize(diff:, path:, type: :create_file)
             #   Instruction describing how to create a file via the apply_patch tool.
             #
-            #   @param diff [String] Diff to apply.
+            #   @param diff [String]
+            #     Diff to apply.
             #
-            #   @param path [String] Path of the file to create.
+            #   @param path [String]
+            #     Path of the file to create.
             #
-            #   @param type [Symbol, :create_file] Create a new file with the provided diff.
+            #   @param type [Symbol, :create_file]
+            #     Create a new file with the provided diff.
           end
 
           class DeleteFile < OpenAI::Internal::Type::BaseModel
@@ -136,9 +145,11 @@ module OpenAI
             # @!method initialize(path:, type: :delete_file)
             #   Instruction describing how to delete a file via the apply_patch tool.
             #
-            #   @param path [String] Path of the file to delete.
+            #   @param path [String]
+            #     Path of the file to delete.
             #
-            #   @param type [Symbol, :delete_file] Delete the specified file.
+            #   @param type [Symbol, :delete_file]
+            #     Delete the specified file.
           end
 
           class UpdateFile < OpenAI::Internal::Type::BaseModel
@@ -163,11 +174,14 @@ module OpenAI
             # @!method initialize(diff:, path:, type: :update_file)
             #   Instruction describing how to update a file via the apply_patch tool.
             #
-            #   @param diff [String] Diff to apply.
+            #   @param diff [String]
+            #     Diff to apply.
             #
-            #   @param path [String] Path of the file to update.
+            #   @param path [String]
+            #     Path of the file to update.
             #
-            #   @param type [Symbol, :update_file] Update an existing file with the provided diff.
+            #   @param type [Symbol, :update_file]
+            #     Update an existing file with the provided diff.
           end
 
           # @!method self.variants
@@ -222,7 +236,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_apply_patch_tool_call_output.rb

@@ -53,24 +53,29 @@ module OpenAI
         optional :output, String, nil?: true
 
         # @!method initialize(id:, call_id:, status:, caller_: nil, created_by: nil, output: nil, type: :apply_patch_call_output)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput} for more details.
-        #
         #   The output emitted by an apply patch tool call.
         #
-        #   @param id [String] The unique ID of the apply patch tool call output. Populated when this item is r
+        #   @param id [String]
+        #     The unique ID of the apply patch tool call output. Populated when this item is
+        #     returned via API.
         #
-        #   @param call_id [String] The unique ID of the apply patch tool call generated by the model.
+        #   @param call_id [String]
+        #     The unique ID of the apply patch tool call generated by the model.
         #
-        #   @param status [Symbol, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput::Status] The status of the apply patch tool call output. One of `completed` or `failed`.
+        #   @param status [Symbol, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput::Status]
+        #     The status of the apply patch tool call output. One of `completed` or `failed`.
         #
-        #   @param caller_ [OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput::Caller::Direct, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput::Caller::Program, nil] The execution context that produced this tool call.
+        #   @param caller_ [OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput::Caller::Direct, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput::Caller::Program, nil]
+        #     The execution context that produced this tool call.
         #
-        #   @param created_by [String] The ID of the entity that created this tool call output.
+        #   @param created_by [String]
+        #     The ID of the entity that created this tool call output.
         #
-        #   @param output [String, nil] Optional textual output returned by the apply patch tool.
+        #   @param output [String, nil]
+        #     Optional textual output returned by the apply patch tool.
         #
-        #   @param type [Symbol, :apply_patch_call_output] The type of the item. Always `apply_patch_call_output`.
+        #   @param type [Symbol, :apply_patch_call_output]
+        #     The type of the item. Always `apply_patch_call_output`.
 
         # The status of the apply patch tool call output. One of `completed` or `failed`.
         #
@@ -120,7 +125,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_audio_delta_event.rb

@@ -23,16 +23,16 @@ module OpenAI
         required :type, const: :"response.audio.delta"
 
         # @!method initialize(delta:, sequence_number:, type: :"response.audio.delta")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseAudioDeltaEvent} for more details.
-        #
         #   Emitted when there is a partial audio response.
         #
-        #   @param delta [String] A chunk of Base64 encoded response audio bytes.
+        #   @param delta [String]
+        #     A chunk of Base64 encoded response audio bytes.
         #
-        #   @param sequence_number [Integer] A sequence number for this chunk of the stream response.
+        #   @param sequence_number [Integer]
+        #     A sequence number for this chunk of the stream response.
         #
-        #   @param type [Symbol, :"response.audio.delta"] The type of the event. Always `response.audio.delta`.
+        #   @param type [Symbol, :"response.audio.delta"]
+        #     The type of the event. Always `response.audio.delta`.
       end
     end
   end

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

@@ -17,14 +17,13 @@ module OpenAI
         required :type, const: :"response.audio.done"
 
         # @!method initialize(sequence_number:, type: :"response.audio.done")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseAudioDoneEvent} for more details.
-        #
         #   Emitted when the audio response is complete.
         #
-        #   @param sequence_number [Integer] The sequence number of the delta.
+        #   @param sequence_number [Integer]
+        #     The sequence number of the delta.
         #
-        #   @param type [Symbol, :"response.audio.done"] The type of the event. Always `response.audio.done`.
+        #   @param type [Symbol, :"response.audio.done"]
+        #     The type of the event. Always `response.audio.done`.
       end
     end
   end

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

@@ -23,16 +23,16 @@ module OpenAI
         required :type, const: :"response.audio.transcript.delta"
 
         # @!method initialize(delta:, sequence_number:, type: :"response.audio.transcript.delta")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseAudioTranscriptDeltaEvent} for more details.
-        #
         #   Emitted when there is a partial transcript of audio.
         #
-        #   @param delta [String] The partial transcript of the audio response.
+        #   @param delta [String]
+        #     The partial transcript of the audio response.
         #
-        #   @param sequence_number [Integer] The sequence number of this event.
+        #   @param sequence_number [Integer]
+        #     The sequence number of this event.
         #
-        #   @param type [Symbol, :"response.audio.transcript.delta"] The type of the event. Always `response.audio.transcript.delta`.
+        #   @param type [Symbol, :"response.audio.transcript.delta"]
+        #     The type of the event. Always `response.audio.transcript.delta`.
       end
     end
   end

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

@@ -17,14 +17,13 @@ module OpenAI
         required :type, const: :"response.audio.transcript.done"
 
         # @!method initialize(sequence_number:, type: :"response.audio.transcript.done")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseAudioTranscriptDoneEvent} for more details.
-        #
         #   Emitted when the full audio transcript is completed.
         #
-        #   @param sequence_number [Integer] The sequence number of this event.
+        #   @param sequence_number [Integer]
+        #     The sequence number of this event.
         #
-        #   @param type [Symbol, :"response.audio.transcript.done"] The type of the event. Always `response.audio.transcript.done`.
+        #   @param type [Symbol, :"response.audio.transcript.done"]
+        #     The type of the event. Always `response.audio.transcript.done`.
       end
     end
   end

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

@@ -36,21 +36,23 @@ module OpenAI
         required :type, const: :"response.code_interpreter_call_code.delta"
 
         # @!method initialize(delta:, item_id:, output_index:, sequence_number:, type: :"response.code_interpreter_call_code.delta")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseCodeInterpreterCallCodeDeltaEvent} for more
-        #   details.
-        #
         #   Emitted when a partial code snippet is streamed by the code interpreter.
         #
-        #   @param delta [String] The partial code snippet being streamed by the code interpreter.
+        #   @param delta [String]
+        #     The partial code snippet being streamed by the code interpreter.
         #
-        #   @param item_id [String] The unique identifier of the code interpreter tool call item.
+        #   @param item_id [String]
+        #     The unique identifier of the code interpreter tool call item.
         #
-        #   @param output_index [Integer] The index of the output item in the response for which the code is being streame
+        #   @param output_index [Integer]
+        #     The index of the output item in the response for which the code is being
+        #     streamed.
         #
-        #   @param sequence_number [Integer] The sequence number of this event, used to order streaming events.
+        #   @param sequence_number [Integer]
+        #     The sequence number of this event, used to order streaming events.
         #
-        #   @param type [Symbol, :"response.code_interpreter_call_code.delta"] The type of the event. Always `response.code_interpreter_call_code.delta`.
+        #   @param type [Symbol, :"response.code_interpreter_call_code.delta"]
+        #     The type of the event. Always `response.code_interpreter_call_code.delta`.
       end
     end
   end

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

@@ -37,15 +37,20 @@ module OpenAI
         # @!method initialize(code:, item_id:, output_index:, sequence_number:, type: :"response.code_interpreter_call_code.done")
         #   Emitted when the code snippet is finalized by the code interpreter.
         #
-        #   @param code [String] The final code snippet output by the code interpreter.
+        #   @param code [String]
+        #     The final code snippet output by the code interpreter.
         #
-        #   @param item_id [String] The unique identifier of the code interpreter tool call item.
+        #   @param item_id [String]
+        #     The unique identifier of the code interpreter tool call item.
         #
-        #   @param output_index [Integer] The index of the output item in the response for which the code is finalized.
+        #   @param output_index [Integer]
+        #     The index of the output item in the response for which the code is finalized.
         #
-        #   @param sequence_number [Integer] The sequence number of this event, used to order streaming events.
+        #   @param sequence_number [Integer]
+        #     The sequence number of this event, used to order streaming events.
         #
-        #   @param type [Symbol, :"response.code_interpreter_call_code.done"] The type of the event. Always `response.code_interpreter_call_code.done`.
+        #   @param type [Symbol, :"response.code_interpreter_call_code.done"]
+        #     The type of the event. Always `response.code_interpreter_call_code.done`.
       end
     end
   end

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

@@ -30,19 +30,20 @@ module OpenAI
         required :type, const: :"response.code_interpreter_call.completed"
 
         # @!method initialize(item_id:, output_index:, sequence_number:, type: :"response.code_interpreter_call.completed")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseCodeInterpreterCallCompletedEvent} for more
-        #   details.
-        #
         #   Emitted when the code interpreter call is completed.
         #
-        #   @param item_id [String] The unique identifier of the code interpreter tool call item.
+        #   @param item_id [String]
+        #     The unique identifier of the code interpreter tool call item.
         #
-        #   @param output_index [Integer] The index of the output item in the response for which the code interpreter call
+        #   @param output_index [Integer]
+        #     The index of the output item in the response for which the code interpreter call
+        #     is completed.
         #
-        #   @param sequence_number [Integer] The sequence number of this event, used to order streaming events.
+        #   @param sequence_number [Integer]
+        #     The sequence number of this event, used to order streaming events.
         #
-        #   @param type [Symbol, :"response.code_interpreter_call.completed"] The type of the event. Always `response.code_interpreter_call.completed`.
+        #   @param type [Symbol, :"response.code_interpreter_call.completed"]
+        #     The type of the event. Always `response.code_interpreter_call.completed`.
       end
     end
   end

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

@@ -30,19 +30,20 @@ module OpenAI
         required :type, const: :"response.code_interpreter_call.in_progress"
 
         # @!method initialize(item_id:, output_index:, sequence_number:, type: :"response.code_interpreter_call.in_progress")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseCodeInterpreterCallInProgressEvent} for more
-        #   details.
-        #
         #   Emitted when a code interpreter call is in progress.
         #
-        #   @param item_id [String] The unique identifier of the code interpreter tool call item.
+        #   @param item_id [String]
+        #     The unique identifier of the code interpreter tool call item.
         #
-        #   @param output_index [Integer] The index of the output item in the response for which the code interpreter call
+        #   @param output_index [Integer]
+        #     The index of the output item in the response for which the code interpreter call
+        #     is in progress.
         #
-        #   @param sequence_number [Integer] The sequence number of this event, used to order streaming events.
+        #   @param sequence_number [Integer]
+        #     The sequence number of this event, used to order streaming events.
         #
-        #   @param type [Symbol, :"response.code_interpreter_call.in_progress"] The type of the event. Always `response.code_interpreter_call.in_progress`.
+        #   @param type [Symbol, :"response.code_interpreter_call.in_progress"]
+        #     The type of the event. Always `response.code_interpreter_call.in_progress`.
       end
     end
   end

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

@@ -30,19 +30,20 @@ module OpenAI
         required :type, const: :"response.code_interpreter_call.interpreting"
 
         # @!method initialize(item_id:, output_index:, sequence_number:, type: :"response.code_interpreter_call.interpreting")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseCodeInterpreterCallInterpretingEvent} for
-        #   more details.
-        #
         #   Emitted when the code interpreter is actively interpreting the code snippet.
         #
-        #   @param item_id [String] The unique identifier of the code interpreter tool call item.
+        #   @param item_id [String]
+        #     The unique identifier of the code interpreter tool call item.
         #
-        #   @param output_index [Integer] The index of the output item in the response for which the code interpreter is i
+        #   @param output_index [Integer]
+        #     The index of the output item in the response for which the code interpreter is
+        #     interpreting code.
         #
-        #   @param sequence_number [Integer] The sequence number of this event, used to order streaming events.
+        #   @param sequence_number [Integer]
+        #     The sequence number of this event, used to order streaming events.
         #
-        #   @param type [Symbol, :"response.code_interpreter_call.interpreting"] The type of the event. Always `response.code_interpreter_call.interpreting`.
+        #   @param type [Symbol, :"response.code_interpreter_call.interpreting"]
+        #     The type of the event. Always `response.code_interpreter_call.interpreting`.
       end
     end
   end

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

@@ -49,22 +49,27 @@ module OpenAI
         required :type, const: :code_interpreter_call
 
         # @!method initialize(id:, code:, container_id:, outputs:, status:, type: :code_interpreter_call)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseCodeInterpreterToolCall} for more details.
-        #
         #   A tool call to run code.
         #
-        #   @param id [String] The unique ID of the code interpreter tool call.
+        #   @param id [String]
+        #     The unique ID of the code interpreter tool call.
         #
-        #   @param code [String, nil] The code to run, or null if not available.
+        #   @param code [String, nil]
+        #     The code to run, or null if not available.
         #
-        #   @param container_id [String] The ID of the container used to run the code.
+        #   @param container_id [String]
+        #     The ID of the container used to run the code.
         #
-        #   @param outputs [Array<OpenAI::Models::Responses::ResponseCodeInterpreterToolCall::Output::Logs, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall::Output::Image>, nil] The outputs generated by the code interpreter, such as logs or images.
+        #   @param outputs [Array<OpenAI::Models::Responses::ResponseCodeInterpreterToolCall::Output::Logs, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall::Output::Image>, nil]
+        #     The outputs generated by the code interpreter, such as logs or images. Can be
+        #     null if no outputs are available.
         #
-        #   @param status [Symbol, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall::Status] The status of the code interpreter tool call. Valid values are `in_progress`, `c
+        #   @param status [Symbol, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall::Status]
+        #     The status of the code interpreter tool call. Valid values are `in_progress`,
+        #     `completed`, `incomplete`, `interpreting`, and `failed`.
         #
-        #   @param type [Symbol, :code_interpreter_call] The type of the code interpreter tool call. Always `code_interpreter_call`.
+        #   @param type [Symbol, :code_interpreter_call]
+        #     The type of the code interpreter tool call. Always `code_interpreter_call`.
 
         # The logs output from the code interpreter.
         module Output
@@ -94,9 +99,11 @@ module OpenAI
             # @!method initialize(logs:, type: :logs)
             #   The logs output from the code interpreter.
             #
-            #   @param logs [String] The logs output from the code interpreter.
+            #   @param logs [String]
+            #     The logs output from the code interpreter.
             #
-            #   @param type [Symbol, :logs] The type of the output. Always `logs`.
+            #   @param type [Symbol, :logs]
+            #     The type of the output. Always `logs`.
           end
 
           class Image < OpenAI::Internal::Type::BaseModel
@@ -115,9 +122,11 @@ module OpenAI
             # @!method initialize(url:, type: :image)
             #   The image output from the code interpreter.
             #
-            #   @param url [String] The URL of the image output from the code interpreter.
+            #   @param url [String]
+            #     The URL of the image output from the code interpreter.
             #
-            #   @param type [Symbol, :image] The type of the output. Always `image`.
+            #   @param type [Symbol, :image]
+            #     The type of the output. Always `image`.
           end
 
           # @!method self.variants