openai 0.91.0 → 0.93.0

data/sig/openai/models/responses/response_apply_patch_tool_call.rbs

@@ -13,22 +13,48 @@ module OpenAI
         }
 
       class ResponseApplyPatchToolCall < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the apply patch tool call. Populated when this item is returned
+        # via API.
         attr_accessor id: String
 
+        # The unique ID of the apply patch tool call generated by the model.
         attr_accessor call_id: String
 
+        # One of the create_file, delete_file, or update_file operations applied via
+        # apply_patch.
         attr_accessor operation: OpenAI::Models::Responses::ResponseApplyPatchToolCall::operation
 
+        # The status of the apply patch tool call. One of `in_progress` or `completed`.
         attr_accessor status: OpenAI::Models::Responses::ResponseApplyPatchToolCall::status
 
+        # The type of the item. Always `apply_patch_call`.
         attr_accessor type: :apply_patch_call
 
+        # The execution context that produced this tool call.
         attr_accessor caller_: OpenAI::Models::Responses::ResponseApplyPatchToolCall::caller_?
 
+        # The ID of the entity that created this tool call.
         attr_reader created_by: String?
 
+        # The ID of the entity that created this tool call.
         def created_by=: (String) -> String
 
+        # @param id
+        #   The unique ID of the apply patch tool call. Populated when this item is returned
+        #   via API.
+        # @param call_id
+        #   The unique ID of the apply patch tool call generated by the model.
+        # @param operation
+        #   One of the create_file, delete_file, or update_file operations applied via
+        #   apply_patch.
+        # @param status
+        #   The status of the apply patch tool call. One of `in_progress` or `completed`.
+        # @param caller_
+        #   The execution context that produced this tool call.
+        # @param created_by
+        #   The ID of the entity that created this tool call.
+        # @param type
+        #   The type of the item. Always `apply_patch_call`.
         def initialize: (
           id: String,
           call_id: String,
@@ -60,12 +86,21 @@ module OpenAI
           type create_file = { diff: String, path: String, ?type: :create_file }
 
           class CreateFile < OpenAI::Internal::Type::BaseModel
+            # Diff to apply.
             attr_accessor diff: String
 
+            # Path of the file to create.
             attr_accessor path: String
 
+            # Create a new file with the provided diff.
             attr_accessor type: :create_file
 
+            # @param diff
+            #   Diff to apply.
+            # @param path
+            #   Path of the file to create.
+            # @param type
+            #   Create a new file with the provided diff.
             def initialize: (
               diff: String,
               path: String,
@@ -78,10 +113,16 @@ module OpenAI
           type delete_file = { path: String, ?type: :delete_file }
 
           class DeleteFile < OpenAI::Internal::Type::BaseModel
+            # Path of the file to delete.
             attr_accessor path: String
 
+            # Delete the specified file.
             attr_accessor type: :delete_file
 
+            # @param path
+            #   Path of the file to delete.
+            # @param type
+            #   Delete the specified file.
             def initialize: (path: String, ?type: :delete_file) -> void
 
             def to_hash: -> { path: String, ?type: :delete_file }
@@ -90,12 +131,21 @@ module OpenAI
           type update_file = { diff: String, path: String, ?type: :update_file }
 
           class UpdateFile < OpenAI::Internal::Type::BaseModel
+            # Diff to apply.
             attr_accessor diff: String
 
+            # Path of the file to update.
             attr_accessor path: String
 
+            # Update an existing file with the provided diff.
             attr_accessor type: :update_file
 
+            # @param diff
+            #   Diff to apply.
+            # @param path
+            #   Path of the file to update.
+            # @param type
+            #   Update an existing file with the provided diff.
             def initialize: (
               diff: String,
               path: String,
@@ -139,10 +189,13 @@ module OpenAI
           type program = { caller_id: String, ?type: :program }
 
           class Program < OpenAI::Internal::Type::BaseModel
+            # The call ID of the program item that produced this tool call.
             attr_accessor caller_id: String
 
             attr_accessor type: :program
 
+            # @param caller_id
+            #   The call ID of the program item that produced this tool call.
             def initialize: (caller_id: String, ?type: :program) -> void
 
             def to_hash: -> { caller_id: String, ?type: :program }

data/sig/openai/models/responses/response_apply_patch_tool_call_output.rbs

@@ -13,22 +13,46 @@ module OpenAI
         }
 
       class ResponseApplyPatchToolCallOutput < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the apply patch tool call output. Populated when this item is
+        # returned via API.
         attr_accessor id: String
 
+        # The unique ID of the apply patch tool call generated by the model.
         attr_accessor call_id: String
 
+        # The status of the apply patch tool call output. One of `completed` or `failed`.
         attr_accessor status: OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput::status
 
+        # The type of the item. Always `apply_patch_call_output`.
         attr_accessor type: :apply_patch_call_output
 
+        # The execution context that produced this tool call.
         attr_accessor caller_: OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput::caller_?
 
+        # The ID of the entity that created this tool call output.
         attr_reader created_by: String?
 
+        # The ID of the entity that created this tool call output.
         def created_by=: (String) -> String
 
+        # Optional textual output returned by the apply patch tool.
         attr_accessor output: String?
 
+        # @param id
+        #   The unique ID of the apply patch tool call output. Populated when this item is
+        #   returned via API.
+        # @param call_id
+        #   The unique ID of the apply patch tool call generated by the model.
+        # @param status
+        #   The status of the apply patch tool call output. One of `completed` or `failed`.
+        # @param caller_
+        #   The execution context that produced this tool call.
+        # @param created_by
+        #   The ID of the entity that created this tool call output.
+        # @param output
+        #   Optional textual output returned by the apply patch tool.
+        # @param type
+        #   The type of the item. Always `apply_patch_call_output`.
         def initialize: (
           id: String,
           call_id: String,
@@ -80,10 +104,13 @@ module OpenAI
           type program = { caller_id: String, ?type: :program }
 
           class Program < OpenAI::Internal::Type::BaseModel
+            # The call ID of the program item that produced this tool call.
             attr_accessor caller_id: String
 
             attr_accessor type: :program
 
+            # @param caller_id
+            #   The call ID of the program item that produced this tool call.
             def initialize: (caller_id: String, ?type: :program) -> void
 
             def to_hash: -> { caller_id: String, ?type: :program }

data/sig/openai/models/responses/response_audio_delta_event.rbs

@@ -9,12 +9,21 @@ module OpenAI
         }
 
       class ResponseAudioDeltaEvent < OpenAI::Internal::Type::BaseModel
+        # A chunk of Base64 encoded response audio bytes.
         attr_accessor delta: String
 
+        # A sequence number for this chunk of the stream response.
         attr_accessor sequence_number: Integer
 
+        # The type of the event. Always `response.audio.delta`.
         attr_accessor type: :"response.audio.delta"
 
+        # @param delta
+        #   A chunk of Base64 encoded response audio bytes.
+        # @param sequence_number
+        #   A sequence number for this chunk of the stream response.
+        # @param type
+        #   The type of the event. Always `response.audio.delta`.
         def initialize: (
           delta: String,
           sequence_number: Integer,

data/sig/openai/models/responses/response_audio_done_event.rbs

@@ -5,10 +5,16 @@ module OpenAI
         { sequence_number: Integer, ?type: :"response.audio.done" }
 
       class ResponseAudioDoneEvent < OpenAI::Internal::Type::BaseModel
+        # The sequence number of the delta.
         attr_accessor sequence_number: Integer
 
+        # The type of the event. Always `response.audio.done`.
         attr_accessor type: :"response.audio.done"
 
+        # @param sequence_number
+        #   The sequence number of the delta.
+        # @param type
+        #   The type of the event. Always `response.audio.done`.
         def initialize: (
           sequence_number: Integer,
           ?type: :"response.audio.done"

data/sig/openai/models/responses/response_audio_transcript_delta_event.rbs

@@ -9,12 +9,21 @@ module OpenAI
         }
 
       class ResponseAudioTranscriptDeltaEvent < OpenAI::Internal::Type::BaseModel
+        # The partial transcript of the audio response.
         attr_accessor delta: String
 
+        # The sequence number of this event.
         attr_accessor sequence_number: Integer
 
+        # The type of the event. Always `response.audio.transcript.delta`.
         attr_accessor type: :"response.audio.transcript.delta"
 
+        # @param delta
+        #   The partial transcript of the audio response.
+        # @param sequence_number
+        #   The sequence number of this event.
+        # @param type
+        #   The type of the event. Always `response.audio.transcript.delta`.
         def initialize: (
           delta: String,
           sequence_number: Integer,

data/sig/openai/models/responses/response_audio_transcript_done_event.rbs

@@ -5,10 +5,16 @@ module OpenAI
         { sequence_number: Integer, ?type: :"response.audio.transcript.done" }
 
       class ResponseAudioTranscriptDoneEvent < OpenAI::Internal::Type::BaseModel
+        # The sequence number of this event.
         attr_accessor sequence_number: Integer
 
+        # The type of the event. Always `response.audio.transcript.done`.
         attr_accessor type: :"response.audio.transcript.done"
 
+        # @param sequence_number
+        #   The sequence number of this event.
+        # @param type
+        #   The type of the event. Always `response.audio.transcript.done`.
         def initialize: (
           sequence_number: Integer,
           ?type: :"response.audio.transcript.done"

data/sig/openai/models/responses/response_code_interpreter_call_code_delta_event.rbs

@@ -11,16 +11,33 @@ module OpenAI
         }
 
       class ResponseCodeInterpreterCallCodeDeltaEvent < OpenAI::Internal::Type::BaseModel
+        # The partial code snippet being streamed by the code interpreter.
         attr_accessor delta: String
 
+        # The unique identifier of the code interpreter tool call item.
         attr_accessor item_id: String
 
+        # The index of the output item in the response for which the code is being
+        # streamed.
         attr_accessor output_index: Integer
 
+        # The sequence number of this event, used to order streaming events.
         attr_accessor sequence_number: Integer
 
+        # The type of the event. Always `response.code_interpreter_call_code.delta`.
         attr_accessor type: :"response.code_interpreter_call_code.delta"
 
+        # @param delta
+        #   The partial code snippet being streamed by the code interpreter.
+        # @param item_id
+        #   The unique identifier of the code interpreter tool call item.
+        # @param output_index
+        #   The index of the output item in the response for which the code is being
+        #   streamed.
+        # @param sequence_number
+        #   The sequence number of this event, used to order streaming events.
+        # @param type
+        #   The type of the event. Always `response.code_interpreter_call_code.delta`.
         def initialize: (
           delta: String,
           item_id: String,

data/sig/openai/models/responses/response_code_interpreter_call_code_done_event.rbs

@@ -11,16 +11,31 @@ module OpenAI
         }
 
       class ResponseCodeInterpreterCallCodeDoneEvent < OpenAI::Internal::Type::BaseModel
+        # The final code snippet output by the code interpreter.
         attr_accessor code: String
 
+        # The unique identifier of the code interpreter tool call item.
         attr_accessor item_id: String
 
+        # The index of the output item in the response for which the code is finalized.
         attr_accessor output_index: Integer
 
+        # The sequence number of this event, used to order streaming events.
         attr_accessor sequence_number: Integer
 
+        # The type of the event. Always `response.code_interpreter_call_code.done`.
         attr_accessor type: :"response.code_interpreter_call_code.done"
 
+        # @param code
+        #   The final code snippet output by the code interpreter.
+        # @param item_id
+        #   The unique identifier of the code interpreter tool call item.
+        # @param output_index
+        #   The index of the output item in the response for which the code is finalized.
+        # @param sequence_number
+        #   The sequence number of this event, used to order streaming events.
+        # @param type
+        #   The type of the event. Always `response.code_interpreter_call_code.done`.
         def initialize: (
           code: String,
           item_id: String,

data/sig/openai/models/responses/response_code_interpreter_call_completed_event.rbs

@@ -10,14 +10,28 @@ module OpenAI
         }
 
       class ResponseCodeInterpreterCallCompletedEvent < OpenAI::Internal::Type::BaseModel
+        # The unique identifier of the code interpreter tool call item.
         attr_accessor item_id: String
 
+        # The index of the output item in the response for which the code interpreter call
+        # is completed.
         attr_accessor output_index: Integer
 
+        # The sequence number of this event, used to order streaming events.
         attr_accessor sequence_number: Integer
 
+        # The type of the event. Always `response.code_interpreter_call.completed`.
         attr_accessor type: :"response.code_interpreter_call.completed"
 
+        # @param item_id
+        #   The unique identifier of the code interpreter tool call item.
+        # @param output_index
+        #   The index of the output item in the response for which the code interpreter call
+        #   is completed.
+        # @param sequence_number
+        #   The sequence number of this event, used to order streaming events.
+        # @param type
+        #   The type of the event. Always `response.code_interpreter_call.completed`.
         def initialize: (
           item_id: String,
           output_index: Integer,

data/sig/openai/models/responses/response_code_interpreter_call_in_progress_event.rbs

@@ -10,14 +10,28 @@ module OpenAI
         }
 
       class ResponseCodeInterpreterCallInProgressEvent < OpenAI::Internal::Type::BaseModel
+        # The unique identifier of the code interpreter tool call item.
         attr_accessor item_id: String
 
+        # The index of the output item in the response for which the code interpreter call
+        # is in progress.
         attr_accessor output_index: Integer
 
+        # The sequence number of this event, used to order streaming events.
         attr_accessor sequence_number: Integer
 
+        # The type of the event. Always `response.code_interpreter_call.in_progress`.
         attr_accessor type: :"response.code_interpreter_call.in_progress"
 
+        # @param item_id
+        #   The unique identifier of the code interpreter tool call item.
+        # @param output_index
+        #   The index of the output item in the response for which the code interpreter call
+        #   is in progress.
+        # @param sequence_number
+        #   The sequence number of this event, used to order streaming events.
+        # @param type
+        #   The type of the event. Always `response.code_interpreter_call.in_progress`.
         def initialize: (
           item_id: String,
           output_index: Integer,

data/sig/openai/models/responses/response_code_interpreter_call_interpreting_event.rbs

@@ -10,14 +10,28 @@ module OpenAI
         }
 
       class ResponseCodeInterpreterCallInterpretingEvent < OpenAI::Internal::Type::BaseModel
+        # The unique identifier of the code interpreter tool call item.
         attr_accessor item_id: String
 
+        # The index of the output item in the response for which the code interpreter is
+        # interpreting code.
         attr_accessor output_index: Integer
 
+        # The sequence number of this event, used to order streaming events.
         attr_accessor sequence_number: Integer
 
+        # The type of the event. Always `response.code_interpreter_call.interpreting`.
         attr_accessor type: :"response.code_interpreter_call.interpreting"
 
+        # @param item_id
+        #   The unique identifier of the code interpreter tool call item.
+        # @param output_index
+        #   The index of the output item in the response for which the code interpreter is
+        #   interpreting code.
+        # @param sequence_number
+        #   The sequence number of this event, used to order streaming events.
+        # @param type
+        #   The type of the event. Always `response.code_interpreter_call.interpreting`.
         def initialize: (
           item_id: String,
           output_index: Integer,

data/sig/openai/models/responses/response_code_interpreter_tool_call.rbs

@@ -12,18 +12,40 @@ module OpenAI
         }
 
       class ResponseCodeInterpreterToolCall < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the code interpreter tool call.
         attr_accessor id: String
 
+        # The code to run, or null if not available.
         attr_accessor code: String?
 
+        # The ID of the container used to run the code.
         attr_accessor container_id: String
 
+        # The outputs generated by the code interpreter, such as logs or images. Can be
+        # null if no outputs are available.
         attr_accessor outputs: ::Array[OpenAI::Models::Responses::ResponseCodeInterpreterToolCall::output]?
 
+        # The status of the code interpreter tool call. Valid values are `in_progress`,
+        # `completed`, `incomplete`, `interpreting`, and `failed`.
         attr_accessor status: OpenAI::Models::Responses::ResponseCodeInterpreterToolCall::status
 
+        # The type of the code interpreter tool call. Always `code_interpreter_call`.
         attr_accessor type: :code_interpreter_call
 
+        # @param id
+        #   The unique ID of the code interpreter tool call.
+        # @param code
+        #   The code to run, or null if not available.
+        # @param container_id
+        #   The ID of the container used to run the code.
+        # @param outputs
+        #   The outputs generated by the code interpreter, such as logs or images. Can be
+        #   null if no outputs are available.
+        # @param status
+        #   The status of the code interpreter tool call. Valid values are `in_progress`,
+        #   `completed`, `incomplete`, `interpreting`, and `failed`.
+        # @param type
+        #   The type of the code interpreter tool call. Always `code_interpreter_call`.
         def initialize: (
           id: String,
           code: String?,
@@ -52,10 +74,16 @@ module OpenAI
           type logs = { logs: String, ?type: :logs }
 
           class Logs < OpenAI::Internal::Type::BaseModel
+            # The logs output from the code interpreter.
             attr_accessor logs: String
 
+            # The type of the output. Always `logs`.
             attr_accessor type: :logs
 
+            # @param logs
+            #   The logs output from the code interpreter.
+            # @param type
+            #   The type of the output. Always `logs`.
             def initialize: (logs: String, ?type: :logs) -> void
 
             def to_hash: -> { logs: String, ?type: :logs }
@@ -64,10 +92,16 @@ module OpenAI
           type image = { ?type: :image, url: String }
 
           class Image < OpenAI::Internal::Type::BaseModel
+            # The type of the output. Always `image`.
             attr_accessor type: :image
 
+            # The URL of the image output from the code interpreter.
             attr_accessor url: String
 
+            # @param url
+            #   The URL of the image output from the code interpreter.
+            # @param type
+            #   The type of the output. Always `image`.
             def initialize: (url: String, ?type: :image) -> void
 
             def to_hash: -> { ?type: :image, url: String }