openai 0.92.0 → 0.94.0

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

@@ -15,20 +15,41 @@ module OpenAI
         }
 
       class BetaResponseContentPartAddedEvent < OpenAI::Internal::Type::BaseModel
+        # The index of the content part that was added.
         attr_accessor content_index: Integer
 
+        # The ID of the output item that the content part was added to.
         attr_accessor item_id: String
 
+        # The index of the output item that the content part was added to.
         attr_accessor output_index: Integer
 
+        # The content part that was added.
         attr_accessor part: OpenAI::Models::Beta::BetaResponseContentPartAddedEvent::part
 
+        # The sequence number of this event.
         attr_accessor sequence_number: Integer
 
+        # The type of the event. Always `response.content_part.added`.
         attr_accessor type: :"response.content_part.added"
 
+        # The agent that owns this multi-agent streaming event.
         attr_accessor agent: OpenAI::Beta::BetaResponseContentPartAddedEvent::Agent?
 
+        # @param content_index
+        #   The index of the content part that was added.
+        # @param item_id
+        #   The ID of the output item that the content part was added to.
+        # @param output_index
+        #   The index of the output item that the content part was added to.
+        # @param part
+        #   The content part that was added.
+        # @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.content_part.added`.
         def initialize: (
           content_index: Integer,
           item_id: String,
@@ -60,10 +81,16 @@ module OpenAI
           type reasoning_text = { text: String, ?type: :reasoning_text }
 
           class ReasoningText < OpenAI::Internal::Type::BaseModel
+            # The reasoning text from the model.
             attr_accessor text: String
 
+            # The type of the reasoning text. Always `reasoning_text`.
             attr_accessor type: :reasoning_text
 
+            # @param text
+            #   The reasoning text from the model.
+            # @param type
+            #   The type of the reasoning text. Always `reasoning_text`.
             def initialize: (text: String, ?type: :reasoning_text) -> void
 
             def to_hash: -> { text: String, ?type: :reasoning_text }
@@ -75,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 }

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

@@ -15,20 +15,41 @@ module OpenAI
         }
 
       class BetaResponseContentPartDoneEvent < OpenAI::Internal::Type::BaseModel
+        # The index of the content part that is done.
         attr_accessor content_index: Integer
 
+        # The ID of the output item that the content part was added to.
         attr_accessor item_id: String
 
+        # The index of the output item that the content part was added to.
         attr_accessor output_index: Integer
 
+        # The content part that is done.
         attr_accessor part: OpenAI::Models::Beta::BetaResponseContentPartDoneEvent::part
 
+        # The sequence number of this event.
         attr_accessor sequence_number: Integer
 
+        # The type of the event. Always `response.content_part.done`.
         attr_accessor type: :"response.content_part.done"
 
+        # The agent that owns this multi-agent streaming event.
         attr_accessor agent: OpenAI::Beta::BetaResponseContentPartDoneEvent::Agent?
 
+        # @param content_index
+        #   The index of the content part that is done.
+        # @param item_id
+        #   The ID of the output item that the content part was added to.
+        # @param output_index
+        #   The index of the output item that the content part was added to.
+        # @param part
+        #   The content part that is done.
+        # @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.content_part.done`.
         def initialize: (
           content_index: Integer,
           item_id: String,
@@ -60,10 +81,16 @@ module OpenAI
           type reasoning_text = { text: String, ?type: :reasoning_text }
 
           class ReasoningText < OpenAI::Internal::Type::BaseModel
+            # The reasoning text from the model.
             attr_accessor text: String
 
+            # The type of the reasoning text. Always `reasoning_text`.
             attr_accessor type: :reasoning_text
 
+            # @param text
+            #   The reasoning text from the model.
+            # @param type
+            #   The type of the reasoning text. Always `reasoning_text`.
             def initialize: (text: String, ?type: :reasoning_text) -> void
 
             def to_hash: -> { text: String, ?type: :reasoning_text }
@@ -75,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 }

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

@@ -6,8 +6,11 @@ module OpenAI
       type beta_response_conversation_param = { id: String }
 
       class BetaResponseConversationParam < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the conversation.
         attr_accessor id: String
 
+        # @param id
+        #   The unique ID of the conversation.
         def initialize: (id: String) -> void
 
         def to_hash: -> { id: String }

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

@@ -12,14 +12,26 @@ module OpenAI
         }
 
       class BetaResponseCreatedEvent < OpenAI::Internal::Type::BaseModel
+        # The response that was created.
         attr_accessor response: OpenAI::Beta::BetaResponse
 
+        # The sequence number for this event.
         attr_accessor sequence_number: Integer
 
+        # The type of the event. Always `response.created`.
         attr_accessor type: :"response.created"
 
+        # The agent that owns this multi-agent streaming event.
         attr_accessor agent: OpenAI::Beta::BetaResponseCreatedEvent::Agent?
 
+        # @param response
+        #   The response that was created.
+        # @param sequence_number
+        #   The sequence number for this event.
+        # @param agent
+        #   The agent that owns this multi-agent streaming event.
+        # @param type
+        #   The type of the event. Always `response.created`.
         def initialize: (
           response: OpenAI::Beta::BetaResponse,
           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_custom_tool_call.rbs

@@ -17,30 +17,60 @@ module OpenAI
         }
 
       class BetaResponseCustomToolCall < OpenAI::Internal::Type::BaseModel
+        # An identifier used to map this custom tool call to a tool call output.
         attr_accessor call_id: String
 
+        # The input for the custom tool call generated by the model.
         attr_accessor input: String
 
+        # The name of the custom tool being called.
         attr_accessor name: String
 
+        # The type of the custom tool call. Always `custom_tool_call`.
         attr_accessor type: :custom_tool_call
 
+        # The unique ID of the custom tool call in the OpenAI platform.
         attr_reader id: String?
 
+        # The unique ID of the custom tool call in the OpenAI platform.
         def id=: (String) -> String
 
+        # The agent that produced this item.
         attr_accessor agent: OpenAI::Beta::BetaResponseCustomToolCall::Agent?
 
+        # Whether the custom tool call runs asynchronously.
         attr_reader async: bool?
 
+        # Whether the custom tool call runs asynchronously.
         def async=: (bool) -> bool
 
+        # The execution context that produced this tool call.
         attr_accessor caller_: OpenAI::Models::Beta::BetaResponseCustomToolCall::caller_?
 
+        # The namespace of the custom tool being called.
         attr_reader namespace: String?
 
+        # The namespace of the custom tool being called.
         def namespace=: (String) -> String
 
+        # @param call_id
+        #   An identifier used to map this custom tool call to a tool call output.
+        # @param input
+        #   The input for the custom tool call generated by the model.
+        # @param name
+        #   The name of the custom tool being called.
+        # @param id
+        #   The unique ID of the custom tool call in the OpenAI platform.
+        # @param agent
+        #   The agent that produced this item.
+        # @param async
+        #   Whether the custom tool call runs asynchronously.
+        # @param caller_
+        #   The execution context that produced this tool call.
+        # @param namespace
+        #   The namespace of the custom tool being called.
+        # @param type
+        #   The type of the custom tool call. Always `custom_tool_call`.
         def initialize: (
           call_id: String,
           input: String,
@@ -68,8 +98,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 }
@@ -95,10 +128,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_custom_tool_call_input_delta_event.rbs

@@ -14,18 +14,36 @@ module OpenAI
         }
 
       class BetaResponseCustomToolCallInputDeltaEvent < OpenAI::Internal::Type::BaseModel
+        # The incremental input data (delta) for the custom tool call.
         attr_accessor delta: String
 
+        # Unique identifier for the API item associated with this event.
         attr_accessor item_id: String
 
+        # The index of the output this delta applies to.
         attr_accessor output_index: Integer
 
+        # The sequence number of this event.
         attr_accessor sequence_number: Integer
 
+        # The event type identifier.
         attr_accessor type: :"response.custom_tool_call_input.delta"
 
+        # The agent that owns this multi-agent streaming event.
         attr_accessor agent: OpenAI::Beta::BetaResponseCustomToolCallInputDeltaEvent::Agent?
 
+        # @param delta
+        #   The incremental input data (delta) for the custom tool call.
+        # @param item_id
+        #   Unique identifier for the API item associated with this event.
+        # @param output_index
+        #   The index of the output this delta applies to.
+        # @param sequence_number
+        #   The sequence number of this event.
+        # @param agent
+        #   The agent that owns this multi-agent streaming event.
+        # @param type
+        #   The event type identifier.
         def initialize: (
           delta: 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_custom_tool_call_input_done_event.rbs

@@ -14,18 +14,36 @@ module OpenAI
         }
 
       class BetaResponseCustomToolCallInputDoneEvent < OpenAI::Internal::Type::BaseModel
+        # The complete input data for the custom tool call.
         attr_accessor input: String
 
+        # Unique identifier for the API item associated with this event.
         attr_accessor item_id: String
 
+        # The index of the output this event applies to.
         attr_accessor output_index: Integer
 
+        # The sequence number of this event.
         attr_accessor sequence_number: Integer
 
+        # The event type identifier.
         attr_accessor type: :"response.custom_tool_call_input.done"
 
+        # The agent that owns this multi-agent streaming event.
         attr_accessor agent: OpenAI::Beta::BetaResponseCustomToolCallInputDoneEvent::Agent?
 
+        # @param input
+        #   The complete input data for the custom tool call.
+        # @param item_id
+        #   Unique identifier for the API item associated with this event.
+        # @param output_index
+        #   The index of the output this event applies to.
+        # @param sequence_number
+        #   The sequence number of this event.
+        # @param agent
+        #   The agent that owns this multi-agent streaming event.
+        # @param type
+        #   The event type identifier.
         def initialize: (
           input: 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_custom_tool_call_item.rbs

@@ -19,20 +19,51 @@ module OpenAI
         }
 
       class BetaResponseCustomToolCallItem < OpenAI::Models::Beta::BetaResponseCustomToolCall
+        # The unique ID of the custom tool call item.
         def id: -> String
 
+        # The unique ID of the custom tool call item.
         def id=: (String _) -> String
 
+        # The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+        # Populated when items are returned via API.
         def status: -> OpenAI::Models::Beta::BetaResponseCustomToolCallItem::status
 
+        # The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+        # Populated when items are returned via API.
         def status=: (
           OpenAI::Models::Beta::BetaResponseCustomToolCallItem::status _
         ) -> OpenAI::Models::Beta::BetaResponseCustomToolCallItem::status
 
+        # The identifier of the actor that created the item.
         def created_by: -> String?
 
+        # The identifier of the actor that created the item.
         def created_by=: (String _) -> String
 
+        # @param call_id
+        #   An identifier used to map this custom tool call to a tool call output.
+        # @param input
+        #   The input for the custom tool call generated by the model.
+        # @param name
+        #   The name of the custom tool being called.
+        # @param id
+        #   The unique ID of the custom tool call item.
+        # @param status
+        #   The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+        #   Populated when items are returned via API.
+        # @param agent
+        #   The agent that produced this item.
+        # @param async
+        #   Whether the custom tool call runs asynchronously.
+        # @param caller_
+        #   The execution context that produced this tool call.
+        # @param namespace
+        #   The namespace of the custom tool being called.
+        # @param created_by
+        #   The identifier of the actor that created the item.
+        # @param type
+        #   The type of the custom tool call. Always `custom_tool_call`.
         def initialize: (
           call_id: String,
           input: String,

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

@@ -14,20 +14,41 @@ module OpenAI
         }
 
       class BetaResponseCustomToolCallOutput < OpenAI::Internal::Type::BaseModel
+        # The call ID, used to map this custom tool call output to a custom tool call.
         attr_accessor call_id: String
 
+        # The output from the custom tool call generated by your code. Can be a string or
+        # an list of output content.
         attr_accessor output: OpenAI::Models::Beta::BetaResponseCustomToolCallOutput::output
 
+        # The type of the custom tool call output. Always `custom_tool_call_output`.
         attr_accessor type: :custom_tool_call_output
 
+        # The unique ID of the custom tool call output in the OpenAI platform.
         attr_reader id: String?
 
+        # The unique ID of the custom tool call output in the OpenAI platform.
         def id=: (String) -> String
 
+        # The agent that produced this item.
         attr_accessor agent: OpenAI::Beta::BetaResponseCustomToolCallOutput::Agent?
 
+        # The execution context that produced this tool call.
         attr_accessor caller_: OpenAI::Models::Beta::BetaResponseCustomToolCallOutput::caller_?
 
+        # @param call_id
+        #   The call ID, used to map this custom tool call output to a custom tool call.
+        # @param output
+        #   The output from the custom tool call generated by your code. Can be a string or
+        #   an list of output content.
+        # @param id
+        #   The unique ID of the custom tool call output in the OpenAI platform.
+        # @param agent
+        #   The agent that produced this item.
+        # @param caller_
+        #   The execution context that produced this tool call.
+        # @param type
+        #   The type of the custom tool call output. Always `custom_tool_call_output`.
         def initialize: (
           call_id: String,
           output: OpenAI::Models::Beta::BetaResponseCustomToolCallOutput::output,
@@ -72,8 +93,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 }
@@ -89,8 +113,11 @@ module OpenAI
           type direct = { ?type: :direct }
 
           class Direct < OpenAI::Internal::Type::BaseModel
+            # The caller type. Always `direct`.
             attr_accessor type: :direct
 
+            # @param type
+            #   The caller type. Always `direct`.
             def initialize: (?type: :direct) -> void
 
             def to_hash: -> { ?type: :direct }
@@ -99,10 +126,16 @@ 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
 
+            # The caller type. Always `program`.
             attr_accessor type: :program
 
+            # @param caller_id
+            #   The call ID of the program item that produced this tool call.
+            # @param type
+            #   The caller type. Always `program`.
             def initialize: (caller_id: String, ?type: :program) -> void
 
             def to_hash: -> { caller_id: String, ?type: :program }

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

@@ -16,20 +16,46 @@ module OpenAI
         }
 
       class BetaResponseCustomToolCallOutputItem < OpenAI::Models::Beta::BetaResponseCustomToolCallOutput
+        # The unique ID of the custom tool call output item.
         def id: -> String
 
+        # The unique ID of the custom tool call output item.
         def id=: (String _) -> String
 
+        # The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+        # Populated when items are returned via API.
         def status: -> OpenAI::Models::Beta::BetaResponseCustomToolCallOutputItem::status
 
+        # The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+        # Populated when items are returned via API.
         def status=: (
           OpenAI::Models::Beta::BetaResponseCustomToolCallOutputItem::status _
         ) -> OpenAI::Models::Beta::BetaResponseCustomToolCallOutputItem::status
 
+        # The identifier of the actor that created the item.
         def created_by: -> String?
 
+        # The identifier of the actor that created the item.
         def created_by=: (String _) -> String
 
+        # @param call_id
+        #   The call ID, used to map this custom tool call output to a custom tool call.
+        # @param output
+        #   The output from the custom tool call generated by your code. Can be a string or
+        #   an list of output content.
+        # @param id
+        #   The unique ID of the custom tool call output item.
+        # @param status
+        #   The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+        #   Populated when items are returned via API.
+        # @param agent
+        #   The agent that produced this item.
+        # @param caller_
+        #   The execution context that produced this tool call.
+        # @param created_by
+        #   The identifier of the actor that created the item.
+        # @param type
+        #   The type of the custom tool call output. Always `custom_tool_call_output`.
         def initialize: (
           call_id: String,
           output: OpenAI::Models::Beta::BetaResponseCustomToolCallOutput::output,

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

@@ -11,8 +11,10 @@ module OpenAI
         }
 
       class BetaResponseError < OpenAI::Internal::Type::BaseModel
+        # The error code for the response.
         attr_accessor code: OpenAI::Models::Beta::BetaResponseError::code
 
+        # A human-readable description of the error.
         attr_accessor message: String
 
         attr_reader misalignment: OpenAI::Beta::BetaResponseError::Misalignment?
@@ -21,6 +23,10 @@ module OpenAI
           OpenAI::Beta::BetaResponseError::Misalignment
         ) -> OpenAI::Beta::BetaResponseError::Misalignment
 
+        # @param code
+        #   The error code for the response.
+        # @param message
+        #   A human-readable description of the error.
         def initialize: (
           code: OpenAI::Models::Beta::BetaResponseError::code,
           message: String,
@@ -92,22 +98,34 @@ module OpenAI
           }
 
         class Misalignment < OpenAI::Internal::Type::BaseModel
+          # The public explanation for this block.
           attr_reader detailed_explanation: String?
 
+          # The public explanation for this block.
           def detailed_explanation=: (String) -> String
 
+          # An optional classification; clients must accept additional values.
           attr_reader error_type: OpenAI::Models::Beta::BetaResponseError::Misalignment::error_type?
 
+          # An optional classification; clients must accept additional values.
           def error_type=: (
             OpenAI::Models::Beta::BetaResponseError::Misalignment::error_type
           ) -> OpenAI::Models::Beta::BetaResponseError::Misalignment::error_type
 
+          # An optional public continuation instruction.
           attr_reader steer: OpenAI::Beta::BetaResponseError::Misalignment::Steer?
 
+          # An optional public continuation instruction.
           def steer=: (
             OpenAI::Beta::BetaResponseError::Misalignment::Steer
           ) -> OpenAI::Beta::BetaResponseError::Misalignment::Steer
 
+          # @param detailed_explanation
+          #   The public explanation for this block.
+          # @param error_type
+          #   An optional classification; clients must accept additional values.
+          # @param steer
+          #   An optional public continuation instruction.
           def initialize: (
             ?detailed_explanation: String,
             ?error_type: OpenAI::Models::Beta::BetaResponseError::Misalignment::error_type,
@@ -141,8 +159,11 @@ module OpenAI
           type steer = { message: String }
 
           class Steer < OpenAI::Internal::Type::BaseModel
+            # The public continuation instruction.
             attr_accessor message: String
 
+            # @param message
+            #   The public continuation instruction.
             def initialize: (message: String) -> void
 
             def to_hash: -> { message: String }

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

@@ -14,18 +14,36 @@ module OpenAI
         }
 
       class BetaResponseErrorEvent < OpenAI::Internal::Type::BaseModel
+        # The error code.
         attr_accessor code: String?
 
+        # The error message.
         attr_accessor message: String
 
+        # The error parameter.
         attr_accessor param: String?
 
+        # The sequence number of this event.
         attr_accessor sequence_number: Integer
 
+        # The type of the event. Always `error`.
         attr_accessor type: :error
 
+        # The agent that owns this multi-agent streaming event.
         attr_accessor agent: OpenAI::Beta::BetaResponseErrorEvent::Agent?
 
+        # @param code
+        #   The error code.
+        # @param message
+        #   The error message.
+        # @param param
+        #   The error parameter.
+        # @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 `error`.
         def initialize: (
           code: String?,
           message: 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 }