openai 0.67.0 → 0.69.0

data/rbi/openai/models/beta/beta_response_output_item_added_event.rbi

@@ -0,0 +1,154 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    BetaResponseOutputItemAddedEvent = Beta::BetaResponseOutputItemAddedEvent
+
+    module Beta
+      class BetaResponseOutputItemAddedEvent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Beta::BetaResponseOutputItemAddedEvent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The output item that was added.
+        sig { returns(OpenAI::Beta::BetaResponseOutputItem::Variants) }
+        attr_accessor :item
+
+        # The index of the output item that was added.
+        sig { returns(Integer) }
+        attr_accessor :output_index
+
+        # The sequence number of this event.
+        sig { returns(Integer) }
+        attr_accessor :sequence_number
+
+        # The type of the event. Always `response.output_item.added`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # The agent that owns this multi-agent streaming event.
+        sig do
+          returns(
+            T.nilable(OpenAI::Beta::BetaResponseOutputItemAddedEvent::Agent)
+          )
+        end
+        attr_reader :agent
+
+        sig do
+          params(
+            agent:
+              T.nilable(
+                OpenAI::Beta::BetaResponseOutputItemAddedEvent::Agent::OrHash
+              )
+          ).void
+        end
+        attr_writer :agent
+
+        # Emitted when a new output item is added.
+        sig do
+          params(
+            item:
+              T.any(
+                OpenAI::Beta::BetaResponseOutputMessage::OrHash,
+                OpenAI::Beta::BetaResponseFileSearchToolCall::OrHash,
+                OpenAI::Beta::BetaResponseFunctionToolCall::OrHash,
+                OpenAI::Beta::BetaResponseFunctionToolCallOutputItem::OrHash,
+                OpenAI::Beta::BetaResponseOutputItem::AgentMessage::OrHash,
+                OpenAI::Beta::BetaResponseOutputItem::MultiAgentCall::OrHash,
+                OpenAI::Beta::BetaResponseOutputItem::MultiAgentCallOutput::OrHash,
+                OpenAI::Beta::BetaResponseFunctionWebSearch::OrHash,
+                OpenAI::Beta::BetaResponseComputerToolCall::OrHash,
+                OpenAI::Beta::BetaResponseComputerToolCallOutputItem::OrHash,
+                OpenAI::Beta::BetaResponseReasoningItem::OrHash,
+                OpenAI::Beta::BetaResponseOutputItem::Program::OrHash,
+                OpenAI::Beta::BetaResponseOutputItem::ProgramOutput::OrHash,
+                OpenAI::Beta::BetaResponseToolSearchCall::OrHash,
+                OpenAI::Beta::BetaResponseToolSearchOutputItem::OrHash,
+                OpenAI::Beta::BetaResponseOutputItem::AdditionalTools::OrHash,
+                OpenAI::Beta::BetaResponseCompactionItem::OrHash,
+                OpenAI::Beta::BetaResponseOutputItem::ImageGenerationCall::OrHash,
+                OpenAI::Beta::BetaResponseCodeInterpreterToolCall::OrHash,
+                OpenAI::Beta::BetaResponseOutputItem::LocalShellCall::OrHash,
+                OpenAI::Beta::BetaResponseOutputItem::LocalShellCallOutput::OrHash,
+                OpenAI::Beta::BetaResponseFunctionShellToolCall::OrHash,
+                OpenAI::Beta::BetaResponseFunctionShellToolCallOutput::OrHash,
+                OpenAI::Beta::BetaResponseApplyPatchToolCall::OrHash,
+                OpenAI::Beta::BetaResponseApplyPatchToolCallOutput::OrHash,
+                OpenAI::Beta::BetaResponseOutputItem::McpCall::OrHash,
+                OpenAI::Beta::BetaResponseOutputItem::McpListTools::OrHash,
+                OpenAI::Beta::BetaResponseOutputItem::McpApprovalRequest::OrHash,
+                OpenAI::Beta::BetaResponseOutputItem::McpApprovalResponse::OrHash,
+                OpenAI::Beta::BetaResponseCustomToolCall::OrHash,
+                OpenAI::Beta::BetaResponseCustomToolCallOutputItem::OrHash
+              ),
+            output_index: Integer,
+            sequence_number: Integer,
+            agent:
+              T.nilable(
+                OpenAI::Beta::BetaResponseOutputItemAddedEvent::Agent::OrHash
+              ),
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The output item that was added.
+          item:,
+          # The index of the output item that was added.
+          output_index:,
+          # The sequence number of this event.
+          sequence_number:,
+          # The agent that owns this multi-agent streaming event.
+          agent: nil,
+          # The type of the event. Always `response.output_item.added`.
+          type: :"response.output_item.added"
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              item: OpenAI::Beta::BetaResponseOutputItem::Variants,
+              output_index: Integer,
+              sequence_number: Integer,
+              type: Symbol,
+              agent:
+                T.nilable(OpenAI::Beta::BetaResponseOutputItemAddedEvent::Agent)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Agent < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Beta::BetaResponseOutputItemAddedEvent::Agent,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The canonical name of the agent that produced this item.
+          sig { returns(String) }
+          attr_accessor :agent_name
+
+          # The agent that owns this multi-agent streaming event.
+          sig { params(agent_name: String).returns(T.attached_class) }
+          def self.new(
+            # The canonical name of the agent that produced this item.
+            agent_name:
+          )
+          end
+
+          sig { override.returns({ agent_name: String }) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/beta/beta_response_output_item_done_event.rbi

@@ -0,0 +1,154 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    BetaResponseOutputItemDoneEvent = Beta::BetaResponseOutputItemDoneEvent
+
+    module Beta
+      class BetaResponseOutputItemDoneEvent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Beta::BetaResponseOutputItemDoneEvent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The output item that was marked done.
+        sig { returns(OpenAI::Beta::BetaResponseOutputItem::Variants) }
+        attr_accessor :item
+
+        # The index of the output item that was marked done.
+        sig { returns(Integer) }
+        attr_accessor :output_index
+
+        # The sequence number of this event.
+        sig { returns(Integer) }
+        attr_accessor :sequence_number
+
+        # The type of the event. Always `response.output_item.done`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # The agent that owns this multi-agent streaming event.
+        sig do
+          returns(
+            T.nilable(OpenAI::Beta::BetaResponseOutputItemDoneEvent::Agent)
+          )
+        end
+        attr_reader :agent
+
+        sig do
+          params(
+            agent:
+              T.nilable(
+                OpenAI::Beta::BetaResponseOutputItemDoneEvent::Agent::OrHash
+              )
+          ).void
+        end
+        attr_writer :agent
+
+        # Emitted when an output item is marked done.
+        sig do
+          params(
+            item:
+              T.any(
+                OpenAI::Beta::BetaResponseOutputMessage::OrHash,
+                OpenAI::Beta::BetaResponseFileSearchToolCall::OrHash,
+                OpenAI::Beta::BetaResponseFunctionToolCall::OrHash,
+                OpenAI::Beta::BetaResponseFunctionToolCallOutputItem::OrHash,
+                OpenAI::Beta::BetaResponseOutputItem::AgentMessage::OrHash,
+                OpenAI::Beta::BetaResponseOutputItem::MultiAgentCall::OrHash,
+                OpenAI::Beta::BetaResponseOutputItem::MultiAgentCallOutput::OrHash,
+                OpenAI::Beta::BetaResponseFunctionWebSearch::OrHash,
+                OpenAI::Beta::BetaResponseComputerToolCall::OrHash,
+                OpenAI::Beta::BetaResponseComputerToolCallOutputItem::OrHash,
+                OpenAI::Beta::BetaResponseReasoningItem::OrHash,
+                OpenAI::Beta::BetaResponseOutputItem::Program::OrHash,
+                OpenAI::Beta::BetaResponseOutputItem::ProgramOutput::OrHash,
+                OpenAI::Beta::BetaResponseToolSearchCall::OrHash,
+                OpenAI::Beta::BetaResponseToolSearchOutputItem::OrHash,
+                OpenAI::Beta::BetaResponseOutputItem::AdditionalTools::OrHash,
+                OpenAI::Beta::BetaResponseCompactionItem::OrHash,
+                OpenAI::Beta::BetaResponseOutputItem::ImageGenerationCall::OrHash,
+                OpenAI::Beta::BetaResponseCodeInterpreterToolCall::OrHash,
+                OpenAI::Beta::BetaResponseOutputItem::LocalShellCall::OrHash,
+                OpenAI::Beta::BetaResponseOutputItem::LocalShellCallOutput::OrHash,
+                OpenAI::Beta::BetaResponseFunctionShellToolCall::OrHash,
+                OpenAI::Beta::BetaResponseFunctionShellToolCallOutput::OrHash,
+                OpenAI::Beta::BetaResponseApplyPatchToolCall::OrHash,
+                OpenAI::Beta::BetaResponseApplyPatchToolCallOutput::OrHash,
+                OpenAI::Beta::BetaResponseOutputItem::McpCall::OrHash,
+                OpenAI::Beta::BetaResponseOutputItem::McpListTools::OrHash,
+                OpenAI::Beta::BetaResponseOutputItem::McpApprovalRequest::OrHash,
+                OpenAI::Beta::BetaResponseOutputItem::McpApprovalResponse::OrHash,
+                OpenAI::Beta::BetaResponseCustomToolCall::OrHash,
+                OpenAI::Beta::BetaResponseCustomToolCallOutputItem::OrHash
+              ),
+            output_index: Integer,
+            sequence_number: Integer,
+            agent:
+              T.nilable(
+                OpenAI::Beta::BetaResponseOutputItemDoneEvent::Agent::OrHash
+              ),
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The output item that was marked done.
+          item:,
+          # The index of the output item that was marked done.
+          output_index:,
+          # The sequence number of this event.
+          sequence_number:,
+          # The agent that owns this multi-agent streaming event.
+          agent: nil,
+          # The type of the event. Always `response.output_item.done`.
+          type: :"response.output_item.done"
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              item: OpenAI::Beta::BetaResponseOutputItem::Variants,
+              output_index: Integer,
+              sequence_number: Integer,
+              type: Symbol,
+              agent:
+                T.nilable(OpenAI::Beta::BetaResponseOutputItemDoneEvent::Agent)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Agent < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Beta::BetaResponseOutputItemDoneEvent::Agent,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The canonical name of the agent that produced this item.
+          sig { returns(String) }
+          attr_accessor :agent_name
+
+          # The agent that owns this multi-agent streaming event.
+          sig { params(agent_name: String).returns(T.attached_class) }
+          def self.new(
+            # The canonical name of the agent that produced this item.
+            agent_name:
+          )
+          end
+
+          sig { override.returns({ agent_name: String }) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/beta/beta_response_output_message.rbi

@@ -0,0 +1,267 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    BetaResponseOutputMessage = Beta::BetaResponseOutputMessage
+
+    module Beta
+      class BetaResponseOutputMessage < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Beta::BetaResponseOutputMessage,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The unique ID of the output message.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The content of the output message.
+        sig do
+          returns(
+            T::Array[
+              T.any(
+                OpenAI::Beta::BetaResponseOutputText,
+                OpenAI::Beta::BetaResponseOutputRefusal
+              )
+            ]
+          )
+        end
+        attr_accessor :content
+
+        # The role of the output message. Always `assistant`.
+        sig { returns(Symbol) }
+        attr_accessor :role
+
+        # The status of the message input. One of `in_progress`, `completed`, or
+        # `incomplete`. Populated when input items are returned via API.
+        sig do
+          returns(OpenAI::Beta::BetaResponseOutputMessage::Status::OrSymbol)
+        end
+        attr_accessor :status
+
+        # The type of the output message. Always `message`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # The agent that produced this item.
+        sig do
+          returns(T.nilable(OpenAI::Beta::BetaResponseOutputMessage::Agent))
+        end
+        attr_reader :agent
+
+        sig do
+          params(
+            agent:
+              T.nilable(OpenAI::Beta::BetaResponseOutputMessage::Agent::OrHash)
+          ).void
+        end
+        attr_writer :agent
+
+        # Labels an `assistant` message as intermediate commentary (`commentary`) or the
+        # final answer (`final_answer`). For models like `gpt-5.3-codex` and beyond, when
+        # sending follow-up requests, preserve and resend phase on all assistant messages
+        # — dropping it can degrade performance. Not used for user messages.
+        sig do
+          returns(
+            T.nilable(OpenAI::Beta::BetaResponseOutputMessage::Phase::OrSymbol)
+          )
+        end
+        attr_accessor :phase
+
+        # An output message from the model.
+        sig do
+          params(
+            id: String,
+            content:
+              T::Array[
+                T.any(
+                  OpenAI::Beta::BetaResponseOutputText::OrHash,
+                  OpenAI::Beta::BetaResponseOutputRefusal::OrHash
+                )
+              ],
+            status: OpenAI::Beta::BetaResponseOutputMessage::Status::OrSymbol,
+            agent:
+              T.nilable(OpenAI::Beta::BetaResponseOutputMessage::Agent::OrHash),
+            phase:
+              T.nilable(
+                OpenAI::Beta::BetaResponseOutputMessage::Phase::OrSymbol
+              ),
+            role: Symbol,
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The unique ID of the output message.
+          id:,
+          # The content of the output message.
+          content:,
+          # The status of the message input. One of `in_progress`, `completed`, or
+          # `incomplete`. Populated when input items are returned via API.
+          status:,
+          # The agent that produced this item.
+          agent: nil,
+          # Labels an `assistant` message as intermediate commentary (`commentary`) or the
+          # final answer (`final_answer`). For models like `gpt-5.3-codex` and beyond, when
+          # sending follow-up requests, preserve and resend phase on all assistant messages
+          # — dropping it can degrade performance. Not used for user messages.
+          phase: nil,
+          # The role of the output message. Always `assistant`.
+          role: :assistant,
+          # The type of the output message. Always `message`.
+          type: :message
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              content:
+                T::Array[
+                  T.any(
+                    OpenAI::Beta::BetaResponseOutputText,
+                    OpenAI::Beta::BetaResponseOutputRefusal
+                  )
+                ],
+              role: Symbol,
+              status: OpenAI::Beta::BetaResponseOutputMessage::Status::OrSymbol,
+              type: Symbol,
+              agent: T.nilable(OpenAI::Beta::BetaResponseOutputMessage::Agent),
+              phase:
+                T.nilable(
+                  OpenAI::Beta::BetaResponseOutputMessage::Phase::OrSymbol
+                )
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # A text output from the model.
+        module Content
+          extend OpenAI::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                OpenAI::Beta::BetaResponseOutputText,
+                OpenAI::Beta::BetaResponseOutputRefusal
+              )
+            end
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Beta::BetaResponseOutputMessage::Content::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+        end
+
+        # The status of the message input. One of `in_progress`, `completed`, or
+        # `incomplete`. Populated when input items are returned via API.
+        module Status
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, OpenAI::Beta::BetaResponseOutputMessage::Status)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          IN_PROGRESS =
+            T.let(
+              :in_progress,
+              OpenAI::Beta::BetaResponseOutputMessage::Status::TaggedSymbol
+            )
+          COMPLETED =
+            T.let(
+              :completed,
+              OpenAI::Beta::BetaResponseOutputMessage::Status::TaggedSymbol
+            )
+          INCOMPLETE =
+            T.let(
+              :incomplete,
+              OpenAI::Beta::BetaResponseOutputMessage::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Beta::BetaResponseOutputMessage::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class Agent < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Beta::BetaResponseOutputMessage::Agent,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The canonical name of the agent that produced this item.
+          sig { returns(String) }
+          attr_accessor :agent_name
+
+          # The agent that produced this item.
+          sig { params(agent_name: String).returns(T.attached_class) }
+          def self.new(
+            # The canonical name of the agent that produced this item.
+            agent_name:
+          )
+          end
+
+          sig { override.returns({ agent_name: String }) }
+          def to_hash
+          end
+        end
+
+        # Labels an `assistant` message as intermediate commentary (`commentary`) or the
+        # final answer (`final_answer`). For models like `gpt-5.3-codex` and beyond, when
+        # sending follow-up requests, preserve and resend phase on all assistant messages
+        # — dropping it can degrade performance. Not used for user messages.
+        module Phase
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, OpenAI::Beta::BetaResponseOutputMessage::Phase)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          COMMENTARY =
+            T.let(
+              :commentary,
+              OpenAI::Beta::BetaResponseOutputMessage::Phase::TaggedSymbol
+            )
+          FINAL_ANSWER =
+            T.let(
+              :final_answer,
+              OpenAI::Beta::BetaResponseOutputMessage::Phase::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Beta::BetaResponseOutputMessage::Phase::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/beta/beta_response_output_refusal.rbi

@@ -0,0 +1,41 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    BetaResponseOutputRefusal = Beta::BetaResponseOutputRefusal
+
+    module Beta
+      class BetaResponseOutputRefusal < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Beta::BetaResponseOutputRefusal,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The refusal explanation from the model.
+        sig { returns(String) }
+        attr_accessor :refusal
+
+        # The type of the refusal. Always `refusal`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # A refusal from the model.
+        sig { params(refusal: String, type: Symbol).returns(T.attached_class) }
+        def self.new(
+          # The refusal explanation from the model.
+          refusal:,
+          # The type of the refusal. Always `refusal`.
+          type: :refusal
+        )
+        end
+
+        sig { override.returns({ refusal: String, type: Symbol }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end