openai 0.67.0 → 0.69.0

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseLocalEnvironment < OpenAI::Internal::Type::BaseModel
+        # @!attribute type
+        #   The environment type. Always `local`.
+        #
+        #   @return [Symbol, :local]
+        required :type, const: :local
+
+        # @!method initialize(type: :local)
+        #   Represents the use of a local environment to perform shell actions.
+        #
+        #   @param type [Symbol, :local] The environment type. Always `local`.
+      end
+    end
+
+    BetaResponseLocalEnvironment = Beta::BetaResponseLocalEnvironment
+  end
+end

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

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseMcpCallArgumentsDeltaEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute delta
+        #   A JSON string containing the partial update to the arguments for the MCP tool
+        #   call.
+        #
+        #   @return [String]
+        required :delta, String
+
+        # @!attribute item_id
+        #   The unique identifier of the MCP tool call item being processed.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the output item in the response's output array.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute sequence_number
+        #   The sequence number of this event.
+        #
+        #   @return [Integer]
+        required :sequence_number, Integer
+
+        # @!attribute type
+        #   The type of the event. Always 'response.mcp_call_arguments.delta'.
+        #
+        #   @return [Symbol, :"response.mcp_call_arguments.delta"]
+        required :type, const: :"response.mcp_call_arguments.delta"
+
+        # @!attribute agent
+        #   The agent that owns this multi-agent streaming event.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseMcpCallArgumentsDeltaEvent::Agent, nil]
+        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 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 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 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
+          # @!attribute agent_name
+          #   The canonical name of the agent that produced this item.
+          #
+          #   @return [String]
+          required :agent_name, String
+
+          # @!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.
+        end
+      end
+    end
+
+    BetaResponseMcpCallArgumentsDeltaEvent = Beta::BetaResponseMcpCallArgumentsDeltaEvent
+  end
+end

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

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseMcpCallArgumentsDoneEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute arguments
+        #   A JSON string containing the finalized arguments for the MCP tool call.
+        #
+        #   @return [String]
+        required :arguments, String
+
+        # @!attribute item_id
+        #   The unique identifier of the MCP tool call item being processed.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the output item in the response's output array.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute sequence_number
+        #   The sequence number of this event.
+        #
+        #   @return [Integer]
+        required :sequence_number, Integer
+
+        # @!attribute type
+        #   The type of the event. Always 'response.mcp_call_arguments.done'.
+        #
+        #   @return [Symbol, :"response.mcp_call_arguments.done"]
+        required :type, const: :"response.mcp_call_arguments.done"
+
+        # @!attribute agent
+        #   The agent that owns this multi-agent streaming event.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseMcpCallArgumentsDoneEvent::Agent, nil]
+        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 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 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 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
+          # @!attribute agent_name
+          #   The canonical name of the agent that produced this item.
+          #
+          #   @return [String]
+          required :agent_name, String
+
+          # @!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.
+        end
+      end
+    end
+
+    BetaResponseMcpCallArgumentsDoneEvent = Beta::BetaResponseMcpCallArgumentsDoneEvent
+  end
+end

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

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseMcpCallCompletedEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute item_id
+        #   The ID of the MCP tool call item that completed.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the output item that completed.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute sequence_number
+        #   The sequence number of this event.
+        #
+        #   @return [Integer]
+        required :sequence_number, Integer
+
+        # @!attribute type
+        #   The type of the event. Always 'response.mcp_call.completed'.
+        #
+        #   @return [Symbol, :"response.mcp_call.completed"]
+        required :type, const: :"response.mcp_call.completed"
+
+        # @!attribute agent
+        #   The agent that owns this multi-agent streaming event.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseMcpCallCompletedEvent::Agent, nil]
+        optional :agent, -> { OpenAI::Beta::BetaResponseMcpCallCompletedEvent::Agent }, nil?: true
+
+        # @!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 output_index [Integer] The index of the output item that completed.
+        #
+        #   @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 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
+          # @!attribute agent_name
+          #   The canonical name of the agent that produced this item.
+          #
+          #   @return [String]
+          required :agent_name, String
+
+          # @!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.
+        end
+      end
+    end
+
+    BetaResponseMcpCallCompletedEvent = Beta::BetaResponseMcpCallCompletedEvent
+  end
+end

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

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseMcpCallFailedEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute item_id
+        #   The ID of the MCP tool call item that failed.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the output item that failed.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute sequence_number
+        #   The sequence number of this event.
+        #
+        #   @return [Integer]
+        required :sequence_number, Integer
+
+        # @!attribute type
+        #   The type of the event. Always 'response.mcp_call.failed'.
+        #
+        #   @return [Symbol, :"response.mcp_call.failed"]
+        required :type, const: :"response.mcp_call.failed"
+
+        # @!attribute agent
+        #   The agent that owns this multi-agent streaming event.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseMcpCallFailedEvent::Agent, nil]
+        optional :agent, -> { OpenAI::Beta::BetaResponseMcpCallFailedEvent::Agent }, nil?: true
+
+        # @!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 output_index [Integer] The index of the output item that failed.
+        #
+        #   @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 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
+          # @!attribute agent_name
+          #   The canonical name of the agent that produced this item.
+          #
+          #   @return [String]
+          required :agent_name, String
+
+          # @!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.
+        end
+      end
+    end
+
+    BetaResponseMcpCallFailedEvent = Beta::BetaResponseMcpCallFailedEvent
+  end
+end

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

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseMcpCallInProgressEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute item_id
+        #   The unique identifier of the MCP tool call item being processed.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the output item in the response's output array.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute sequence_number
+        #   The sequence number of this event.
+        #
+        #   @return [Integer]
+        required :sequence_number, Integer
+
+        # @!attribute type
+        #   The type of the event. Always 'response.mcp_call.in_progress'.
+        #
+        #   @return [Symbol, :"response.mcp_call.in_progress"]
+        required :type, const: :"response.mcp_call.in_progress"
+
+        # @!attribute agent
+        #   The agent that owns this multi-agent streaming event.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseMcpCallInProgressEvent::Agent, nil]
+        optional :agent, -> { OpenAI::Beta::BetaResponseMcpCallInProgressEvent::Agent }, nil?: true
+
+        # @!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 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 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'.
+
+        # @see OpenAI::Models::Beta::BetaResponseMcpCallInProgressEvent#agent
+        class Agent < OpenAI::Internal::Type::BaseModel
+          # @!attribute agent_name
+          #   The canonical name of the agent that produced this item.
+          #
+          #   @return [String]
+          required :agent_name, String
+
+          # @!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.
+        end
+      end
+    end
+
+    BetaResponseMcpCallInProgressEvent = Beta::BetaResponseMcpCallInProgressEvent
+  end
+end

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

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseMcpListToolsCompletedEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute item_id
+        #   The ID of the MCP tool call item that produced this output.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the output item that was processed.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute sequence_number
+        #   The sequence number of this event.
+        #
+        #   @return [Integer]
+        required :sequence_number, Integer
+
+        # @!attribute type
+        #   The type of the event. Always 'response.mcp_list_tools.completed'.
+        #
+        #   @return [Symbol, :"response.mcp_list_tools.completed"]
+        required :type, const: :"response.mcp_list_tools.completed"
+
+        # @!attribute agent
+        #   The agent that owns this multi-agent streaming event.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseMcpListToolsCompletedEvent::Agent, nil]
+        optional :agent, -> { OpenAI::Beta::BetaResponseMcpListToolsCompletedEvent::Agent }, nil?: true
+
+        # @!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 output_index [Integer] The index of the output item that was processed.
+        #
+        #   @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 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
+          # @!attribute agent_name
+          #   The canonical name of the agent that produced this item.
+          #
+          #   @return [String]
+          required :agent_name, String
+
+          # @!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.
+        end
+      end
+    end
+
+    BetaResponseMcpListToolsCompletedEvent = Beta::BetaResponseMcpListToolsCompletedEvent
+  end
+end

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

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseMcpListToolsFailedEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute item_id
+        #   The ID of the MCP tool call item that failed.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the output item that failed.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute sequence_number
+        #   The sequence number of this event.
+        #
+        #   @return [Integer]
+        required :sequence_number, Integer
+
+        # @!attribute type
+        #   The type of the event. Always 'response.mcp_list_tools.failed'.
+        #
+        #   @return [Symbol, :"response.mcp_list_tools.failed"]
+        required :type, const: :"response.mcp_list_tools.failed"
+
+        # @!attribute agent
+        #   The agent that owns this multi-agent streaming event.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseMcpListToolsFailedEvent::Agent, nil]
+        optional :agent, -> { OpenAI::Beta::BetaResponseMcpListToolsFailedEvent::Agent }, nil?: true
+
+        # @!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 output_index [Integer] The index of the output item that failed.
+        #
+        #   @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 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
+          # @!attribute agent_name
+          #   The canonical name of the agent that produced this item.
+          #
+          #   @return [String]
+          required :agent_name, String
+
+          # @!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.
+        end
+      end
+    end
+
+    BetaResponseMcpListToolsFailedEvent = Beta::BetaResponseMcpListToolsFailedEvent
+  end
+end

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

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseMcpListToolsInProgressEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute item_id
+        #   The ID of the MCP tool call item that is being processed.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the output item that is being processed.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute sequence_number
+        #   The sequence number of this event.
+        #
+        #   @return [Integer]
+        required :sequence_number, Integer
+
+        # @!attribute type
+        #   The type of the event. Always 'response.mcp_list_tools.in_progress'.
+        #
+        #   @return [Symbol, :"response.mcp_list_tools.in_progress"]
+        required :type, const: :"response.mcp_list_tools.in_progress"
+
+        # @!attribute agent
+        #   The agent that owns this multi-agent streaming event.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseMcpListToolsInProgressEvent::Agent, nil]
+        optional :agent, -> { OpenAI::Beta::BetaResponseMcpListToolsInProgressEvent::Agent }, nil?: true
+
+        # @!method initialize(item_id:, output_index:, sequence_number:, agent: nil, type: :"response.mcp_list_tools.in_progress")
+        #   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 output_index [Integer] The index of the output item that is being processed.
+        #
+        #   @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 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
+          # @!attribute agent_name
+          #   The canonical name of the agent that produced this item.
+          #
+          #   @return [String]
+          required :agent_name, String
+
+          # @!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.
+        end
+      end
+    end
+
+    BetaResponseMcpListToolsInProgressEvent = Beta::BetaResponseMcpListToolsInProgressEvent
+  end
+end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseOutputAudio < OpenAI::Internal::Type::BaseModel
+        # @!attribute data
+        #   Base64-encoded audio data from the model.
+        #
+        #   @return [String]
+        required :data, String
+
+        # @!attribute transcript
+        #   The transcript of the audio data from the model.
+        #
+        #   @return [String]
+        required :transcript, String
+
+        # @!attribute type
+        #   The type of the output audio. Always `output_audio`.
+        #
+        #   @return [Symbol, :output_audio]
+        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 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`.
+      end
+    end
+
+    BetaResponseOutputAudio = Beta::BetaResponseOutputAudio
+  end
+end