openai 0.92.0 → 0.93.0

data/sig/openai/models/beta/beta_response_apply_patch_tool_call.rbs

@@ -16,28 +16,58 @@ module OpenAI
         }
 
       class BetaResponseApplyPatchToolCall < 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::Beta::BetaResponseApplyPatchToolCall::operation
 
+        # The status of the apply patch tool call. One of `in_progress` or `completed`.
         attr_accessor status: OpenAI::Models::Beta::BetaResponseApplyPatchToolCall::status
 
+        # The type of the item. Always `apply_patch_call`.
         attr_accessor type: :apply_patch_call
 
+        # The agent that produced this item.
         attr_reader agent: OpenAI::Beta::BetaResponseApplyPatchToolCall::Agent?
 
+        # The agent that produced this item.
         def agent=: (
           OpenAI::Beta::BetaResponseApplyPatchToolCall::Agent
         ) -> OpenAI::Beta::BetaResponseApplyPatchToolCall::Agent
 
+        # The execution context that produced this tool call.
         attr_accessor caller_: OpenAI::Models::Beta::BetaResponseApplyPatchToolCall::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 agent
+        #   The agent that produced this item.
+        # @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,
@@ -71,12 +101,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,
@@ -89,10 +128,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 }
@@ -101,12 +146,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,
@@ -133,8 +187,11 @@ module OpenAI
         type agent = { agent_name: String }
 
         class Agent < OpenAI::Internal::Type::BaseModel
+          # The canonical name of the agent that produced this item.
           attr_accessor agent_name: String
 
+          # @param agent_name
+          #   The canonical name of the agent that produced this item.
           def initialize: (agent_name: String) -> void
 
           def to_hash: -> { agent_name: String }
@@ -160,10 +217,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/beta/beta_response_apply_patch_tool_call_output.rbs

@@ -16,28 +16,56 @@ module OpenAI
         }
 
       class BetaResponseApplyPatchToolCallOutput < 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::Beta::BetaResponseApplyPatchToolCallOutput::status
 
+        # The type of the item. Always `apply_patch_call_output`.
         attr_accessor type: :apply_patch_call_output
 
+        # The agent that produced this item.
         attr_reader agent: OpenAI::Beta::BetaResponseApplyPatchToolCallOutput::Agent?
 
+        # The agent that produced this item.
         def agent=: (
           OpenAI::Beta::BetaResponseApplyPatchToolCallOutput::Agent
         ) -> OpenAI::Beta::BetaResponseApplyPatchToolCallOutput::Agent
 
+        # The execution context that produced this tool call.
         attr_accessor caller_: OpenAI::Models::Beta::BetaResponseApplyPatchToolCallOutput::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 agent
+        #   The agent that produced this item.
+        # @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,
@@ -74,8 +102,11 @@ module OpenAI
         type agent = { agent_name: String }
 
         class Agent < OpenAI::Internal::Type::BaseModel
+          # The canonical name of the agent that produced this item.
           attr_accessor agent_name: String
 
+          # @param agent_name
+          #   The canonical name of the agent that produced this item.
           def initialize: (agent_name: String) -> void
 
           def to_hash: -> { agent_name: String }
@@ -101,10 +132,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/beta/beta_response_audio_delta_event.rbs

@@ -12,14 +12,26 @@ module OpenAI
         }
 
       class BetaResponseAudioDeltaEvent < 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"
 
+        # The agent that owns this multi-agent streaming event.
         attr_accessor agent: OpenAI::Beta::BetaResponseAudioDeltaEvent::Agent?
 
+        # @param delta
+        #   A chunk of Base64 encoded response audio bytes.
+        # @param sequence_number
+        #   A sequence number for this chunk of the stream response.
+        # @param agent
+        #   The agent that owns this multi-agent streaming event.
+        # @param type
+        #   The type of the event. Always `response.audio.delta`.
         def initialize: (
           delta: String,
           sequence_number: Integer,
@@ -37,8 +49,11 @@ module OpenAI
         type agent = { agent_name: String }
 
         class Agent < OpenAI::Internal::Type::BaseModel
+          # The canonical name of the agent that produced this item.
           attr_accessor agent_name: String
 
+          # @param agent_name
+          #   The canonical name of the agent that produced this item.
           def initialize: (agent_name: String) -> void
 
           def to_hash: -> { agent_name: String }

data/sig/openai/models/beta/beta_response_audio_done_event.rbs

@@ -11,12 +11,21 @@ module OpenAI
         }
 
       class BetaResponseAudioDoneEvent < 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"
 
+        # The agent that owns this multi-agent streaming event.
         attr_accessor agent: OpenAI::Beta::BetaResponseAudioDoneEvent::Agent?
 
+        # @param sequence_number
+        #   The sequence number of the delta.
+        # @param agent
+        #   The agent that owns this multi-agent streaming event.
+        # @param type
+        #   The type of the event. Always `response.audio.done`.
         def initialize: (
           sequence_number: Integer,
           ?agent: OpenAI::Beta::BetaResponseAudioDoneEvent::Agent?,
@@ -32,8 +41,11 @@ module OpenAI
         type agent = { agent_name: String }
 
         class Agent < OpenAI::Internal::Type::BaseModel
+          # The canonical name of the agent that produced this item.
           attr_accessor agent_name: String
 
+          # @param agent_name
+          #   The canonical name of the agent that produced this item.
           def initialize: (agent_name: String) -> void
 
           def to_hash: -> { agent_name: String }

data/sig/openai/models/beta/beta_response_audio_transcript_delta_event.rbs

@@ -12,14 +12,26 @@ module OpenAI
         }
 
       class BetaResponseAudioTranscriptDeltaEvent < 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"
 
+        # The agent that owns this multi-agent streaming event.
         attr_accessor agent: OpenAI::Beta::BetaResponseAudioTranscriptDeltaEvent::Agent?
 
+        # @param delta
+        #   The partial transcript of the audio response.
+        # @param sequence_number
+        #   The sequence number of this event.
+        # @param agent
+        #   The agent that owns this multi-agent streaming event.
+        # @param type
+        #   The type of the event. Always `response.audio.transcript.delta`.
         def initialize: (
           delta: String,
           sequence_number: Integer,
@@ -37,8 +49,11 @@ module OpenAI
         type agent = { agent_name: String }
 
         class Agent < OpenAI::Internal::Type::BaseModel
+          # The canonical name of the agent that produced this item.
           attr_accessor agent_name: String
 
+          # @param agent_name
+          #   The canonical name of the agent that produced this item.
           def initialize: (agent_name: String) -> void
 
           def to_hash: -> { agent_name: String }

data/sig/openai/models/beta/beta_response_audio_transcript_done_event.rbs

@@ -11,12 +11,21 @@ module OpenAI
         }
 
       class BetaResponseAudioTranscriptDoneEvent < 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"
 
+        # The agent that owns this multi-agent streaming event.
         attr_accessor agent: OpenAI::Beta::BetaResponseAudioTranscriptDoneEvent::Agent?
 
+        # @param sequence_number
+        #   The sequence number of this event.
+        # @param agent
+        #   The agent that owns this multi-agent streaming event.
+        # @param type
+        #   The type of the event. Always `response.audio.transcript.done`.
         def initialize: (
           sequence_number: Integer,
           ?agent: OpenAI::Beta::BetaResponseAudioTranscriptDoneEvent::Agent?,
@@ -32,8 +41,11 @@ module OpenAI
         type agent = { agent_name: String }
 
         class Agent < OpenAI::Internal::Type::BaseModel
+          # The canonical name of the agent that produced this item.
           attr_accessor agent_name: String
 
+          # @param agent_name
+          #   The canonical name of the agent that produced this item.
           def initialize: (agent_name: String) -> void
 
           def to_hash: -> { agent_name: String }

data/sig/openai/models/beta/beta_response_code_interpreter_call_code_delta_event.rbs

@@ -14,18 +14,38 @@ module OpenAI
         }
 
       class BetaResponseCodeInterpreterCallCodeDeltaEvent < 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"
 
+        # The agent that owns this multi-agent streaming event.
         attr_accessor agent: OpenAI::Beta::BetaResponseCodeInterpreterCallCodeDeltaEvent::Agent?
 
+        # @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 agent
+        #   The agent that owns this multi-agent streaming event.
+        # @param type
+        #   The type of the event. Always `response.code_interpreter_call_code.delta`.
         def initialize: (
           delta: String,
           item_id: String,
@@ -47,8 +67,11 @@ module OpenAI
         type agent = { agent_name: String }
 
         class Agent < OpenAI::Internal::Type::BaseModel
+          # The canonical name of the agent that produced this item.
           attr_accessor agent_name: String
 
+          # @param agent_name
+          #   The canonical name of the agent that produced this item.
           def initialize: (agent_name: String) -> void
 
           def to_hash: -> { agent_name: String }

data/sig/openai/models/beta/beta_response_code_interpreter_call_code_done_event.rbs

@@ -14,18 +14,36 @@ module OpenAI
         }
 
       class BetaResponseCodeInterpreterCallCodeDoneEvent < 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"
 
+        # The agent that owns this multi-agent streaming event.
         attr_accessor agent: OpenAI::Beta::BetaResponseCodeInterpreterCallCodeDoneEvent::Agent?
 
+        # @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 agent
+        #   The agent that owns this multi-agent streaming event.
+        # @param type
+        #   The type of the event. Always `response.code_interpreter_call_code.done`.
         def initialize: (
           code: String,
           item_id: String,
@@ -47,8 +65,11 @@ module OpenAI
         type agent = { agent_name: String }
 
         class Agent < OpenAI::Internal::Type::BaseModel
+          # The canonical name of the agent that produced this item.
           attr_accessor agent_name: String
 
+          # @param agent_name
+          #   The canonical name of the agent that produced this item.
           def initialize: (agent_name: String) -> void
 
           def to_hash: -> { agent_name: String }

data/sig/openai/models/beta/beta_response_code_interpreter_call_completed_event.rbs

@@ -13,16 +13,33 @@ module OpenAI
         }
 
       class BetaResponseCodeInterpreterCallCompletedEvent < 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"
 
+        # The agent that owns this multi-agent streaming event.
         attr_accessor agent: OpenAI::Beta::BetaResponseCodeInterpreterCallCompletedEvent::Agent?
 
+        # @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 agent
+        #   The agent that owns this multi-agent streaming event.
+        # @param type
+        #   The type of the event. Always `response.code_interpreter_call.completed`.
         def initialize: (
           item_id: String,
           output_index: Integer,
@@ -42,8 +59,11 @@ module OpenAI
         type agent = { agent_name: String }
 
         class Agent < OpenAI::Internal::Type::BaseModel
+          # The canonical name of the agent that produced this item.
           attr_accessor agent_name: String
 
+          # @param agent_name
+          #   The canonical name of the agent that produced this item.
           def initialize: (agent_name: String) -> void
 
           def to_hash: -> { agent_name: String }

data/sig/openai/models/beta/beta_response_code_interpreter_call_in_progress_event.rbs

@@ -13,16 +13,33 @@ module OpenAI
         }
 
       class BetaResponseCodeInterpreterCallInProgressEvent < 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"
 
+        # The agent that owns this multi-agent streaming event.
         attr_accessor agent: OpenAI::Beta::BetaResponseCodeInterpreterCallInProgressEvent::Agent?
 
+        # @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 agent
+        #   The agent that owns this multi-agent streaming event.
+        # @param type
+        #   The type of the event. Always `response.code_interpreter_call.in_progress`.
         def initialize: (
           item_id: String,
           output_index: Integer,
@@ -42,8 +59,11 @@ module OpenAI
         type agent = { agent_name: String }
 
         class Agent < OpenAI::Internal::Type::BaseModel
+          # The canonical name of the agent that produced this item.
           attr_accessor agent_name: String
 
+          # @param agent_name
+          #   The canonical name of the agent that produced this item.
           def initialize: (agent_name: String) -> void
 
           def to_hash: -> { agent_name: String }

data/sig/openai/models/beta/beta_response_code_interpreter_call_interpreting_event.rbs

@@ -13,16 +13,33 @@ module OpenAI
         }
 
       class BetaResponseCodeInterpreterCallInterpretingEvent < 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"
 
+        # The agent that owns this multi-agent streaming event.
         attr_accessor agent: OpenAI::Beta::BetaResponseCodeInterpreterCallInterpretingEvent::Agent?
 
+        # @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 agent
+        #   The agent that owns this multi-agent streaming event.
+        # @param type
+        #   The type of the event. Always `response.code_interpreter_call.interpreting`.
         def initialize: (
           item_id: String,
           output_index: Integer,
@@ -42,8 +59,11 @@ module OpenAI
         type agent = { agent_name: String }
 
         class Agent < OpenAI::Internal::Type::BaseModel
+          # The canonical name of the agent that produced this item.
           attr_accessor agent_name: String
 
+          # @param agent_name
+          #   The canonical name of the agent that produced this item.
           def initialize: (agent_name: String) -> void
 
           def to_hash: -> { agent_name: String }