openai 0.68.0 → 0.69.0

data/rbi/openai/models/beta/beta_response_audio_delta_event.rbi

@@ -0,0 +1,110 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    BetaResponseAudioDeltaEvent = Beta::BetaResponseAudioDeltaEvent
+
+    module Beta
+      class BetaResponseAudioDeltaEvent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Beta::BetaResponseAudioDeltaEvent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # A chunk of Base64 encoded response audio bytes.
+        sig { returns(String) }
+        attr_accessor :delta
+
+        # A sequence number for this chunk of the stream response.
+        sig { returns(Integer) }
+        attr_accessor :sequence_number
+
+        # The type of the event. Always `response.audio.delta`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # The agent that owns this multi-agent streaming event.
+        sig do
+          returns(T.nilable(OpenAI::Beta::BetaResponseAudioDeltaEvent::Agent))
+        end
+        attr_reader :agent
+
+        sig do
+          params(
+            agent:
+              T.nilable(
+                OpenAI::Beta::BetaResponseAudioDeltaEvent::Agent::OrHash
+              )
+          ).void
+        end
+        attr_writer :agent
+
+        # Emitted when there is a partial audio response.
+        sig do
+          params(
+            delta: String,
+            sequence_number: Integer,
+            agent:
+              T.nilable(
+                OpenAI::Beta::BetaResponseAudioDeltaEvent::Agent::OrHash
+              ),
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # A chunk of Base64 encoded response audio bytes.
+          delta:,
+          # A sequence number for this chunk of the stream response.
+          sequence_number:,
+          # The agent that owns this multi-agent streaming event.
+          agent: nil,
+          # The type of the event. Always `response.audio.delta`.
+          type: :"response.audio.delta"
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              delta: String,
+              sequence_number: Integer,
+              type: Symbol,
+              agent: T.nilable(OpenAI::Beta::BetaResponseAudioDeltaEvent::Agent)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Agent < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Beta::BetaResponseAudioDeltaEvent::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_audio_done_event.rbi

@@ -0,0 +1,100 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    BetaResponseAudioDoneEvent = Beta::BetaResponseAudioDoneEvent
+
+    module Beta
+      class BetaResponseAudioDoneEvent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Beta::BetaResponseAudioDoneEvent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The sequence number of the delta.
+        sig { returns(Integer) }
+        attr_accessor :sequence_number
+
+        # The type of the event. Always `response.audio.done`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # The agent that owns this multi-agent streaming event.
+        sig do
+          returns(T.nilable(OpenAI::Beta::BetaResponseAudioDoneEvent::Agent))
+        end
+        attr_reader :agent
+
+        sig do
+          params(
+            agent:
+              T.nilable(OpenAI::Beta::BetaResponseAudioDoneEvent::Agent::OrHash)
+          ).void
+        end
+        attr_writer :agent
+
+        # Emitted when the audio response is complete.
+        sig do
+          params(
+            sequence_number: Integer,
+            agent:
+              T.nilable(
+                OpenAI::Beta::BetaResponseAudioDoneEvent::Agent::OrHash
+              ),
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The sequence number of the delta.
+          sequence_number:,
+          # The agent that owns this multi-agent streaming event.
+          agent: nil,
+          # The type of the event. Always `response.audio.done`.
+          type: :"response.audio.done"
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              sequence_number: Integer,
+              type: Symbol,
+              agent: T.nilable(OpenAI::Beta::BetaResponseAudioDoneEvent::Agent)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Agent < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Beta::BetaResponseAudioDoneEvent::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_audio_transcript_delta_event.rbi

@@ -0,0 +1,118 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    BetaResponseAudioTranscriptDeltaEvent =
+      Beta::BetaResponseAudioTranscriptDeltaEvent
+
+    module Beta
+      class BetaResponseAudioTranscriptDeltaEvent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Beta::BetaResponseAudioTranscriptDeltaEvent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The partial transcript of the audio response.
+        sig { returns(String) }
+        attr_accessor :delta
+
+        # The sequence number of this event.
+        sig { returns(Integer) }
+        attr_accessor :sequence_number
+
+        # The type of the event. Always `response.audio.transcript.delta`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # The agent that owns this multi-agent streaming event.
+        sig do
+          returns(
+            T.nilable(
+              OpenAI::Beta::BetaResponseAudioTranscriptDeltaEvent::Agent
+            )
+          )
+        end
+        attr_reader :agent
+
+        sig do
+          params(
+            agent:
+              T.nilable(
+                OpenAI::Beta::BetaResponseAudioTranscriptDeltaEvent::Agent::OrHash
+              )
+          ).void
+        end
+        attr_writer :agent
+
+        # Emitted when there is a partial transcript of audio.
+        sig do
+          params(
+            delta: String,
+            sequence_number: Integer,
+            agent:
+              T.nilable(
+                OpenAI::Beta::BetaResponseAudioTranscriptDeltaEvent::Agent::OrHash
+              ),
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The partial transcript of the audio response.
+          delta:,
+          # 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.audio.transcript.delta`.
+          type: :"response.audio.transcript.delta"
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              delta: String,
+              sequence_number: Integer,
+              type: Symbol,
+              agent:
+                T.nilable(
+                  OpenAI::Beta::BetaResponseAudioTranscriptDeltaEvent::Agent
+                )
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Agent < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Beta::BetaResponseAudioTranscriptDeltaEvent::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_audio_transcript_done_event.rbi

@@ -0,0 +1,108 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    BetaResponseAudioTranscriptDoneEvent =
+      Beta::BetaResponseAudioTranscriptDoneEvent
+
+    module Beta
+      class BetaResponseAudioTranscriptDoneEvent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Beta::BetaResponseAudioTranscriptDoneEvent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The sequence number of this event.
+        sig { returns(Integer) }
+        attr_accessor :sequence_number
+
+        # The type of the event. Always `response.audio.transcript.done`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # The agent that owns this multi-agent streaming event.
+        sig do
+          returns(
+            T.nilable(OpenAI::Beta::BetaResponseAudioTranscriptDoneEvent::Agent)
+          )
+        end
+        attr_reader :agent
+
+        sig do
+          params(
+            agent:
+              T.nilable(
+                OpenAI::Beta::BetaResponseAudioTranscriptDoneEvent::Agent::OrHash
+              )
+          ).void
+        end
+        attr_writer :agent
+
+        # Emitted when the full audio transcript is completed.
+        sig do
+          params(
+            sequence_number: Integer,
+            agent:
+              T.nilable(
+                OpenAI::Beta::BetaResponseAudioTranscriptDoneEvent::Agent::OrHash
+              ),
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # 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.audio.transcript.done`.
+          type: :"response.audio.transcript.done"
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              sequence_number: Integer,
+              type: Symbol,
+              agent:
+                T.nilable(
+                  OpenAI::Beta::BetaResponseAudioTranscriptDoneEvent::Agent
+                )
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Agent < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Beta::BetaResponseAudioTranscriptDoneEvent::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_code_interpreter_call_code_delta_event.rbi

@@ -0,0 +1,136 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    BetaResponseCodeInterpreterCallCodeDeltaEvent =
+      Beta::BetaResponseCodeInterpreterCallCodeDeltaEvent
+
+    module Beta
+      class BetaResponseCodeInterpreterCallCodeDeltaEvent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Beta::BetaResponseCodeInterpreterCallCodeDeltaEvent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The partial code snippet being streamed by the code interpreter.
+        sig { returns(String) }
+        attr_accessor :delta
+
+        # The unique identifier of the code interpreter tool call item.
+        sig { returns(String) }
+        attr_accessor :item_id
+
+        # The index of the output item in the response for which the code is being
+        # streamed.
+        sig { returns(Integer) }
+        attr_accessor :output_index
+
+        # The sequence number of this event, used to order streaming events.
+        sig { returns(Integer) }
+        attr_accessor :sequence_number
+
+        # The type of the event. Always `response.code_interpreter_call_code.delta`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # The agent that owns this multi-agent streaming event.
+        sig do
+          returns(
+            T.nilable(
+              OpenAI::Beta::BetaResponseCodeInterpreterCallCodeDeltaEvent::Agent
+            )
+          )
+        end
+        attr_reader :agent
+
+        sig do
+          params(
+            agent:
+              T.nilable(
+                OpenAI::Beta::BetaResponseCodeInterpreterCallCodeDeltaEvent::Agent::OrHash
+              )
+          ).void
+        end
+        attr_writer :agent
+
+        # Emitted when a partial code snippet is streamed by the code interpreter.
+        sig do
+          params(
+            delta: String,
+            item_id: String,
+            output_index: Integer,
+            sequence_number: Integer,
+            agent:
+              T.nilable(
+                OpenAI::Beta::BetaResponseCodeInterpreterCallCodeDeltaEvent::Agent::OrHash
+              ),
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The partial code snippet being streamed by the code interpreter.
+          delta:,
+          # The unique identifier of the code interpreter tool call item.
+          item_id:,
+          # The index of the output item in the response for which the code is being
+          # streamed.
+          output_index:,
+          # The sequence number of this event, used to order streaming events.
+          sequence_number:,
+          # The agent that owns this multi-agent streaming event.
+          agent: nil,
+          # The type of the event. Always `response.code_interpreter_call_code.delta`.
+          type: :"response.code_interpreter_call_code.delta"
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              delta: String,
+              item_id: String,
+              output_index: Integer,
+              sequence_number: Integer,
+              type: Symbol,
+              agent:
+                T.nilable(
+                  OpenAI::Beta::BetaResponseCodeInterpreterCallCodeDeltaEvent::Agent
+                )
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Agent < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Beta::BetaResponseCodeInterpreterCallCodeDeltaEvent::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_code_interpreter_call_code_done_event.rbi

@@ -0,0 +1,134 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    BetaResponseCodeInterpreterCallCodeDoneEvent =
+      Beta::BetaResponseCodeInterpreterCallCodeDoneEvent
+
+    module Beta
+      class BetaResponseCodeInterpreterCallCodeDoneEvent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Beta::BetaResponseCodeInterpreterCallCodeDoneEvent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The final code snippet output by the code interpreter.
+        sig { returns(String) }
+        attr_accessor :code
+
+        # The unique identifier of the code interpreter tool call item.
+        sig { returns(String) }
+        attr_accessor :item_id
+
+        # The index of the output item in the response for which the code is finalized.
+        sig { returns(Integer) }
+        attr_accessor :output_index
+
+        # The sequence number of this event, used to order streaming events.
+        sig { returns(Integer) }
+        attr_accessor :sequence_number
+
+        # The type of the event. Always `response.code_interpreter_call_code.done`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # The agent that owns this multi-agent streaming event.
+        sig do
+          returns(
+            T.nilable(
+              OpenAI::Beta::BetaResponseCodeInterpreterCallCodeDoneEvent::Agent
+            )
+          )
+        end
+        attr_reader :agent
+
+        sig do
+          params(
+            agent:
+              T.nilable(
+                OpenAI::Beta::BetaResponseCodeInterpreterCallCodeDoneEvent::Agent::OrHash
+              )
+          ).void
+        end
+        attr_writer :agent
+
+        # Emitted when the code snippet is finalized by the code interpreter.
+        sig do
+          params(
+            code: String,
+            item_id: String,
+            output_index: Integer,
+            sequence_number: Integer,
+            agent:
+              T.nilable(
+                OpenAI::Beta::BetaResponseCodeInterpreterCallCodeDoneEvent::Agent::OrHash
+              ),
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The final code snippet output by the code interpreter.
+          code:,
+          # The unique identifier of the code interpreter tool call item.
+          item_id:,
+          # The index of the output item in the response for which the code is finalized.
+          output_index:,
+          # The sequence number of this event, used to order streaming events.
+          sequence_number:,
+          # The agent that owns this multi-agent streaming event.
+          agent: nil,
+          # The type of the event. Always `response.code_interpreter_call_code.done`.
+          type: :"response.code_interpreter_call_code.done"
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              code: String,
+              item_id: String,
+              output_index: Integer,
+              sequence_number: Integer,
+              type: Symbol,
+              agent:
+                T.nilable(
+                  OpenAI::Beta::BetaResponseCodeInterpreterCallCodeDoneEvent::Agent
+                )
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Agent < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Beta::BetaResponseCodeInterpreterCallCodeDoneEvent::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