openai 0.86.0 → 0.88.0

data/lib/openai/models/beta/beta_response_local_environment.rb

@@ -13,7 +13,8 @@ module OpenAI
         # @!method initialize(type: :local)
         #   Represents the use of a local environment to perform shell actions.
         #
-        #   @param type [Symbol, :local] The environment type. Always `local`.
+        #   @param type [Symbol, :local]
+        #     The environment type. Always `local`.
       end
     end
 

data/lib/openai/models/beta/beta_response_mcp_call_arguments_delta_event.rb

@@ -42,23 +42,27 @@ module OpenAI
         optional :agent, -> { OpenAI::Beta::BetaResponseMcpCallArgumentsDeltaEvent::Agent }, nil?: true
 
         # @!method initialize(delta:, item_id:, output_index:, sequence_number:, agent: nil, type: :"response.mcp_call_arguments.delta")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Beta::BetaResponseMcpCallArgumentsDeltaEvent} for more details.
-        #
         #   Emitted when there is a delta (partial update) to the arguments of an MCP tool
         #   call.
         #
-        #   @param delta [String] A JSON string containing the partial update to the arguments for the MCP tool ca
+        #   @param delta [String]
+        #     A JSON string containing the partial update to the arguments for the MCP tool
+        #     call.
         #
-        #   @param item_id [String] The unique identifier of the MCP tool call item being processed.
+        #   @param item_id [String]
+        #     The unique identifier of the MCP tool call item being processed.
         #
-        #   @param output_index [Integer] The index of the output item in the response's output array.
+        #   @param output_index [Integer]
+        #     The index of the output item in the response's output array.
         #
-        #   @param sequence_number [Integer] The sequence number of this event.
+        #   @param sequence_number [Integer]
+        #     The sequence number of this event.
         #
-        #   @param agent [OpenAI::Models::Beta::BetaResponseMcpCallArgumentsDeltaEvent::Agent, nil] The agent that owns this multi-agent streaming event.
+        #   @param agent [OpenAI::Models::Beta::BetaResponseMcpCallArgumentsDeltaEvent::Agent, nil]
+        #     The agent that owns this multi-agent streaming event.
         #
-        #   @param type [Symbol, :"response.mcp_call_arguments.delta"] The type of the event. Always 'response.mcp_call_arguments.delta'.
+        #   @param type [Symbol, :"response.mcp_call_arguments.delta"]
+        #     The type of the event. Always 'response.mcp_call_arguments.delta'.
 
         # @see OpenAI::Models::Beta::BetaResponseMcpCallArgumentsDeltaEvent#agent
         class Agent < OpenAI::Internal::Type::BaseModel
@@ -71,7 +75,8 @@ module OpenAI
           # @!method initialize(agent_name:)
           #   The agent that owns this multi-agent streaming event.
           #
-          #   @param agent_name [String] The canonical name of the agent that produced this item.
+          #   @param agent_name [String]
+          #     The canonical name of the agent that produced this item.
         end
       end
     end

data/lib/openai/models/beta/beta_response_mcp_call_arguments_done_event.rb

@@ -41,22 +41,25 @@ module OpenAI
         optional :agent, -> { OpenAI::Beta::BetaResponseMcpCallArgumentsDoneEvent::Agent }, nil?: true
 
         # @!method initialize(arguments:, item_id:, output_index:, sequence_number:, agent: nil, type: :"response.mcp_call_arguments.done")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Beta::BetaResponseMcpCallArgumentsDoneEvent} for more details.
-        #
         #   Emitted when the arguments for an MCP tool call are finalized.
         #
-        #   @param arguments [String] A JSON string containing the finalized arguments for the MCP tool call.
+        #   @param arguments [String]
+        #     A JSON string containing the finalized arguments for the MCP tool call.
         #
-        #   @param item_id [String] The unique identifier of the MCP tool call item being processed.
+        #   @param item_id [String]
+        #     The unique identifier of the MCP tool call item being processed.
         #
-        #   @param output_index [Integer] The index of the output item in the response's output array.
+        #   @param output_index [Integer]
+        #     The index of the output item in the response's output array.
         #
-        #   @param sequence_number [Integer] The sequence number of this event.
+        #   @param sequence_number [Integer]
+        #     The sequence number of this event.
         #
-        #   @param agent [OpenAI::Models::Beta::BetaResponseMcpCallArgumentsDoneEvent::Agent, nil] The agent that owns this multi-agent streaming event.
+        #   @param agent [OpenAI::Models::Beta::BetaResponseMcpCallArgumentsDoneEvent::Agent, nil]
+        #     The agent that owns this multi-agent streaming event.
         #
-        #   @param type [Symbol, :"response.mcp_call_arguments.done"] The type of the event. Always 'response.mcp_call_arguments.done'.
+        #   @param type [Symbol, :"response.mcp_call_arguments.done"]
+        #     The type of the event. Always 'response.mcp_call_arguments.done'.
 
         # @see OpenAI::Models::Beta::BetaResponseMcpCallArgumentsDoneEvent#agent
         class Agent < OpenAI::Internal::Type::BaseModel
@@ -69,7 +72,8 @@ module OpenAI
           # @!method initialize(agent_name:)
           #   The agent that owns this multi-agent streaming event.
           #
-          #   @param agent_name [String] The canonical name of the agent that produced this item.
+          #   @param agent_name [String]
+          #     The canonical name of the agent that produced this item.
         end
       end
     end

data/lib/openai/models/beta/beta_response_mcp_call_completed_event.rb

@@ -37,15 +37,20 @@ module OpenAI
         # @!method initialize(item_id:, output_index:, sequence_number:, agent: nil, type: :"response.mcp_call.completed")
         #   Emitted when an MCP tool call has completed successfully.
         #
-        #   @param item_id [String] The ID of the MCP tool call item that completed.
+        #   @param item_id [String]
+        #     The ID of the MCP tool call item that completed.
         #
-        #   @param output_index [Integer] The index of the output item that completed.
+        #   @param output_index [Integer]
+        #     The index of the output item that completed.
         #
-        #   @param sequence_number [Integer] The sequence number of this event.
+        #   @param sequence_number [Integer]
+        #     The sequence number of this event.
         #
-        #   @param agent [OpenAI::Models::Beta::BetaResponseMcpCallCompletedEvent::Agent, nil] The agent that owns this multi-agent streaming event.
+        #   @param agent [OpenAI::Models::Beta::BetaResponseMcpCallCompletedEvent::Agent, nil]
+        #     The agent that owns this multi-agent streaming event.
         #
-        #   @param type [Symbol, :"response.mcp_call.completed"] The type of the event. Always 'response.mcp_call.completed'.
+        #   @param type [Symbol, :"response.mcp_call.completed"]
+        #     The type of the event. Always 'response.mcp_call.completed'.
 
         # @see OpenAI::Models::Beta::BetaResponseMcpCallCompletedEvent#agent
         class Agent < OpenAI::Internal::Type::BaseModel
@@ -58,7 +63,8 @@ module OpenAI
           # @!method initialize(agent_name:)
           #   The agent that owns this multi-agent streaming event.
           #
-          #   @param agent_name [String] The canonical name of the agent that produced this item.
+          #   @param agent_name [String]
+          #     The canonical name of the agent that produced this item.
         end
       end
     end

data/lib/openai/models/beta/beta_response_mcp_call_failed_event.rb

@@ -37,15 +37,20 @@ module OpenAI
         # @!method initialize(item_id:, output_index:, sequence_number:, agent: nil, type: :"response.mcp_call.failed")
         #   Emitted when an MCP tool call has failed.
         #
-        #   @param item_id [String] The ID of the MCP tool call item that failed.
+        #   @param item_id [String]
+        #     The ID of the MCP tool call item that failed.
         #
-        #   @param output_index [Integer] The index of the output item that failed.
+        #   @param output_index [Integer]
+        #     The index of the output item that failed.
         #
-        #   @param sequence_number [Integer] The sequence number of this event.
+        #   @param sequence_number [Integer]
+        #     The sequence number of this event.
         #
-        #   @param agent [OpenAI::Models::Beta::BetaResponseMcpCallFailedEvent::Agent, nil] The agent that owns this multi-agent streaming event.
+        #   @param agent [OpenAI::Models::Beta::BetaResponseMcpCallFailedEvent::Agent, nil]
+        #     The agent that owns this multi-agent streaming event.
         #
-        #   @param type [Symbol, :"response.mcp_call.failed"] The type of the event. Always 'response.mcp_call.failed'.
+        #   @param type [Symbol, :"response.mcp_call.failed"]
+        #     The type of the event. Always 'response.mcp_call.failed'.
 
         # @see OpenAI::Models::Beta::BetaResponseMcpCallFailedEvent#agent
         class Agent < OpenAI::Internal::Type::BaseModel
@@ -58,7 +63,8 @@ module OpenAI
           # @!method initialize(agent_name:)
           #   The agent that owns this multi-agent streaming event.
           #
-          #   @param agent_name [String] The canonical name of the agent that produced this item.
+          #   @param agent_name [String]
+          #     The canonical name of the agent that produced this item.
         end
       end
     end

data/lib/openai/models/beta/beta_response_mcp_call_in_progress_event.rb

@@ -37,15 +37,20 @@ module OpenAI
         # @!method initialize(item_id:, output_index:, sequence_number:, agent: nil, type: :"response.mcp_call.in_progress")
         #   Emitted when an MCP tool call is in progress.
         #
-        #   @param item_id [String] The unique identifier of the MCP tool call item being processed.
+        #   @param item_id [String]
+        #     The unique identifier of the MCP tool call item being processed.
         #
-        #   @param output_index [Integer] The index of the output item in the response's output array.
+        #   @param output_index [Integer]
+        #     The index of the output item in the response's output array.
         #
-        #   @param sequence_number [Integer] The sequence number of this event.
+        #   @param sequence_number [Integer]
+        #     The sequence number of this event.
         #
-        #   @param agent [OpenAI::Models::Beta::BetaResponseMcpCallInProgressEvent::Agent, nil] The agent that owns this multi-agent streaming event.
+        #   @param agent [OpenAI::Models::Beta::BetaResponseMcpCallInProgressEvent::Agent, nil]
+        #     The agent that owns this multi-agent streaming event.
         #
-        #   @param type [Symbol, :"response.mcp_call.in_progress"] The type of the event. Always 'response.mcp_call.in_progress'.
+        #   @param type [Symbol, :"response.mcp_call.in_progress"]
+        #     The type of the event. Always 'response.mcp_call.in_progress'.
 
         # @see OpenAI::Models::Beta::BetaResponseMcpCallInProgressEvent#agent
         class Agent < OpenAI::Internal::Type::BaseModel
@@ -58,7 +63,8 @@ module OpenAI
           # @!method initialize(agent_name:)
           #   The agent that owns this multi-agent streaming event.
           #
-          #   @param agent_name [String] The canonical name of the agent that produced this item.
+          #   @param agent_name [String]
+          #     The canonical name of the agent that produced this item.
         end
       end
     end

data/lib/openai/models/beta/beta_response_mcp_list_tools_completed_event.rb

@@ -37,15 +37,20 @@ module OpenAI
         # @!method initialize(item_id:, output_index:, sequence_number:, agent: nil, type: :"response.mcp_list_tools.completed")
         #   Emitted when the list of available MCP tools has been successfully retrieved.
         #
-        #   @param item_id [String] The ID of the MCP tool call item that produced this output.
+        #   @param item_id [String]
+        #     The ID of the MCP tool call item that produced this output.
         #
-        #   @param output_index [Integer] The index of the output item that was processed.
+        #   @param output_index [Integer]
+        #     The index of the output item that was processed.
         #
-        #   @param sequence_number [Integer] The sequence number of this event.
+        #   @param sequence_number [Integer]
+        #     The sequence number of this event.
         #
-        #   @param agent [OpenAI::Models::Beta::BetaResponseMcpListToolsCompletedEvent::Agent, nil] The agent that owns this multi-agent streaming event.
+        #   @param agent [OpenAI::Models::Beta::BetaResponseMcpListToolsCompletedEvent::Agent, nil]
+        #     The agent that owns this multi-agent streaming event.
         #
-        #   @param type [Symbol, :"response.mcp_list_tools.completed"] The type of the event. Always 'response.mcp_list_tools.completed'.
+        #   @param type [Symbol, :"response.mcp_list_tools.completed"]
+        #     The type of the event. Always 'response.mcp_list_tools.completed'.
 
         # @see OpenAI::Models::Beta::BetaResponseMcpListToolsCompletedEvent#agent
         class Agent < OpenAI::Internal::Type::BaseModel
@@ -58,7 +63,8 @@ module OpenAI
           # @!method initialize(agent_name:)
           #   The agent that owns this multi-agent streaming event.
           #
-          #   @param agent_name [String] The canonical name of the agent that produced this item.
+          #   @param agent_name [String]
+          #     The canonical name of the agent that produced this item.
         end
       end
     end

data/lib/openai/models/beta/beta_response_mcp_list_tools_failed_event.rb

@@ -37,15 +37,20 @@ module OpenAI
         # @!method initialize(item_id:, output_index:, sequence_number:, agent: nil, type: :"response.mcp_list_tools.failed")
         #   Emitted when the attempt to list available MCP tools has failed.
         #
-        #   @param item_id [String] The ID of the MCP tool call item that failed.
+        #   @param item_id [String]
+        #     The ID of the MCP tool call item that failed.
         #
-        #   @param output_index [Integer] The index of the output item that failed.
+        #   @param output_index [Integer]
+        #     The index of the output item that failed.
         #
-        #   @param sequence_number [Integer] The sequence number of this event.
+        #   @param sequence_number [Integer]
+        #     The sequence number of this event.
         #
-        #   @param agent [OpenAI::Models::Beta::BetaResponseMcpListToolsFailedEvent::Agent, nil] The agent that owns this multi-agent streaming event.
+        #   @param agent [OpenAI::Models::Beta::BetaResponseMcpListToolsFailedEvent::Agent, nil]
+        #     The agent that owns this multi-agent streaming event.
         #
-        #   @param type [Symbol, :"response.mcp_list_tools.failed"] The type of the event. Always 'response.mcp_list_tools.failed'.
+        #   @param type [Symbol, :"response.mcp_list_tools.failed"]
+        #     The type of the event. Always 'response.mcp_list_tools.failed'.
 
         # @see OpenAI::Models::Beta::BetaResponseMcpListToolsFailedEvent#agent
         class Agent < OpenAI::Internal::Type::BaseModel
@@ -58,7 +63,8 @@ module OpenAI
           # @!method initialize(agent_name:)
           #   The agent that owns this multi-agent streaming event.
           #
-          #   @param agent_name [String] The canonical name of the agent that produced this item.
+          #   @param agent_name [String]
+          #     The canonical name of the agent that produced this item.
         end
       end
     end

data/lib/openai/models/beta/beta_response_mcp_list_tools_in_progress_event.rb

@@ -38,15 +38,20 @@ module OpenAI
         #   Emitted when the system is in the process of retrieving the list of available
         #   MCP tools.
         #
-        #   @param item_id [String] The ID of the MCP tool call item that is being processed.
+        #   @param item_id [String]
+        #     The ID of the MCP tool call item that is being processed.
         #
-        #   @param output_index [Integer] The index of the output item that is being processed.
+        #   @param output_index [Integer]
+        #     The index of the output item that is being processed.
         #
-        #   @param sequence_number [Integer] The sequence number of this event.
+        #   @param sequence_number [Integer]
+        #     The sequence number of this event.
         #
-        #   @param agent [OpenAI::Models::Beta::BetaResponseMcpListToolsInProgressEvent::Agent, nil] The agent that owns this multi-agent streaming event.
+        #   @param agent [OpenAI::Models::Beta::BetaResponseMcpListToolsInProgressEvent::Agent, nil]
+        #     The agent that owns this multi-agent streaming event.
         #
-        #   @param type [Symbol, :"response.mcp_list_tools.in_progress"] The type of the event. Always 'response.mcp_list_tools.in_progress'.
+        #   @param type [Symbol, :"response.mcp_list_tools.in_progress"]
+        #     The type of the event. Always 'response.mcp_list_tools.in_progress'.
 
         # @see OpenAI::Models::Beta::BetaResponseMcpListToolsInProgressEvent#agent
         class Agent < OpenAI::Internal::Type::BaseModel
@@ -59,7 +64,8 @@ module OpenAI
           # @!method initialize(agent_name:)
           #   The agent that owns this multi-agent streaming event.
           #
-          #   @param agent_name [String] The canonical name of the agent that produced this item.
+          #   @param agent_name [String]
+          #     The canonical name of the agent that produced this item.
         end
       end
     end

data/lib/openai/models/beta/beta_response_output_audio.rb

@@ -23,16 +23,16 @@ module OpenAI
         required :type, const: :output_audio
 
         # @!method initialize(data:, transcript:, type: :output_audio)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Beta::BetaResponseOutputAudio} for more details.
-        #
         #   An audio output from the model.
         #
-        #   @param data [String] Base64-encoded audio data from the model.
+        #   @param data [String]
+        #     Base64-encoded audio data from the model.
         #
-        #   @param transcript [String] The transcript of the audio data from the model.
+        #   @param transcript [String]
+        #     The transcript of the audio data from the model.
         #
-        #   @param type [Symbol, :output_audio] The type of the output audio. Always `output_audio`.
+        #   @param type [Symbol, :output_audio]
+        #     The type of the output audio. Always `output_audio`.
       end
     end