openai 0.89.0 → 0.90.0

data/rbi/openai/models/beta/agent_session_turn_reasoning_summary_part_added_event.rbi

@@ -0,0 +1,127 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Beta
+
+      class AgentSessionTurnReasoningSummaryPartAddedEvent < OpenAI::Internal::Type::BaseModel
+
+        OrHash = T.type_alias do
+          T.any(
+            OpenAI::Beta::AgentSessionTurnReasoningSummaryPartAddedEvent,
+            OpenAI::Internal::AnyHash
+          )
+        end
+
+        # The unique ID of the event.
+        sig { returns(String) }
+        attr_accessor :event_id
+
+        # The ID of the reasoning item.
+        sig { returns(String) }
+        attr_accessor :item_id
+
+        # The index of the item in the turn output.
+        sig { returns(Integer) }
+        attr_accessor :output_index
+
+        # The initial summary part.
+        sig { returns(OpenAI::Beta::SummaryText) }
+        attr_reader :part
+
+        sig { params(part: OpenAI::Beta::SummaryText::OrHash).void }
+        attr_writer :part
+
+        # The ID of the session associated with the event.
+        sig { returns(String) }
+        attr_accessor :session_id
+
+        # The index of the summary content part.
+        sig { returns(Integer) }
+        attr_accessor :summary_index
+
+        # The ID of the turn associated with the event, when applicable.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :turn_id
+
+        # The type of the object. Always
+        # `agent.session.turn.reasoning_summary_part.added`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # Emitted when a reasoning summary content part is added.
+        sig do
+          params(
+
+            event_id: String,
+
+            item_id: String,
+
+            output_index: Integer,
+
+            part: OpenAI::Beta::SummaryText::OrHash,
+
+            session_id: String,
+
+            summary_index: Integer,
+
+            turn_id: T.nilable(String),
+
+            type: Symbol
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+
+          # The unique ID of the event.
+          event_id:,
+
+          # The ID of the reasoning item.
+          item_id:,
+
+          # The index of the item in the turn output.
+          output_index:,
+
+          # The initial summary part.
+          part:,
+
+          # The ID of the session associated with the event.
+          session_id:,
+
+          # The index of the summary content part.
+          summary_index:,
+
+          # The ID of the turn associated with the event, when applicable.
+          turn_id:,
+
+          # The type of the object. Always
+          # `agent.session.turn.reasoning_summary_part.added`.
+
+          type: :"agent.session.turn.reasoning_summary_part.added"
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              event_id: String,
+              item_id: String,
+              output_index: Integer,
+              part: OpenAI::Beta::SummaryText,
+              session_id: String,
+              summary_index: Integer,
+              turn_id: T.nilable(String),
+              type: Symbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/models/beta/agent_session_turn_reasoning_summary_part_done_event.rbi

@@ -0,0 +1,135 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Beta
+
+      class AgentSessionTurnReasoningSummaryPartDoneEvent < OpenAI::Internal::Type::BaseModel
+
+        OrHash = T.type_alias do
+          T.any(
+            OpenAI::Beta::AgentSessionTurnReasoningSummaryPartDoneEvent,
+            OpenAI::Internal::AnyHash
+          )
+        end
+
+        # The unique ID of the event.
+        sig { returns(String) }
+        attr_accessor :event_id
+
+        # The ID of the reasoning item.
+        sig { returns(String) }
+        attr_accessor :item_id
+
+        # The index of the item in the turn output.
+        sig { returns(Integer) }
+        attr_accessor :output_index
+
+        # The completed summary part.
+        sig { returns(OpenAI::Beta::SummaryText) }
+        attr_reader :part
+
+        sig { params(part: OpenAI::Beta::SummaryText::OrHash).void }
+        attr_writer :part
+
+        # The ID of the session associated with the event.
+        sig { returns(String) }
+        attr_accessor :session_id
+
+        # Present as `incomplete` when summary generation was interrupted.
+        sig { returns(T.nilable(Symbol)) }
+        attr_accessor :status
+
+        # The index of the summary part.
+        sig { returns(Integer) }
+        attr_accessor :summary_index
+
+        # The ID of the turn associated with the event, when applicable.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :turn_id
+
+        # The type of the object. Always `agent.session.turn.reasoning_summary_part.done`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # Emitted when a reasoning summary part is complete.
+        sig do
+          params(
+
+            event_id: String,
+
+            item_id: String,
+
+            output_index: Integer,
+
+            part: OpenAI::Beta::SummaryText::OrHash,
+
+            session_id: String,
+
+            summary_index: Integer,
+
+            turn_id: T.nilable(String),
+
+            status: T.nilable(Symbol),
+
+            type: Symbol
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+
+          # The unique ID of the event.
+          event_id:,
+
+          # The ID of the reasoning item.
+          item_id:,
+
+          # The index of the item in the turn output.
+          output_index:,
+
+          # The completed summary part.
+          part:,
+
+          # The ID of the session associated with the event.
+          session_id:,
+
+          # The index of the summary part.
+          summary_index:,
+
+          # The ID of the turn associated with the event, when applicable.
+          turn_id:,
+
+          # Present as `incomplete` when summary generation was interrupted.
+          status: :incomplete,
+
+          # The type of the object. Always `agent.session.turn.reasoning_summary_part.done`.
+
+          type: :"agent.session.turn.reasoning_summary_part.done"
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              event_id: String,
+              item_id: String,
+              output_index: Integer,
+              part: OpenAI::Beta::SummaryText,
+              session_id: String,
+              status: T.nilable(Symbol),
+              summary_index: Integer,
+              turn_id: T.nilable(String),
+              type: Symbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/models/beta/agent_session_turn_reasoning_summary_text_delta_event.rbi

@@ -0,0 +1,124 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Beta
+
+      class AgentSessionTurnReasoningSummaryTextDeltaEvent < OpenAI::Internal::Type::BaseModel
+
+        OrHash = T.type_alias do
+          T.any(
+            OpenAI::Beta::AgentSessionTurnReasoningSummaryTextDeltaEvent,
+            OpenAI::Internal::AnyHash
+          )
+        end
+
+        # The summary text that was appended.
+        sig { returns(String) }
+        attr_accessor :delta
+
+        # The unique ID of the event.
+        sig { returns(String) }
+        attr_accessor :event_id
+
+        # The ID of the reasoning item.
+        sig { returns(String) }
+        attr_accessor :item_id
+
+        # The index of the item in the turn output.
+        sig { returns(Integer) }
+        attr_accessor :output_index
+
+        # The ID of the session associated with the event.
+        sig { returns(String) }
+        attr_accessor :session_id
+
+        # The index of the summary content part.
+        sig { returns(Integer) }
+        attr_accessor :summary_index
+
+        # The ID of the turn associated with the event, when applicable.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :turn_id
+
+        # The type of the object. Always
+        # `agent.session.turn.reasoning_summary_text.delta`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # Emitted when text is appended to a reasoning summary.
+        sig do
+          params(
+
+            delta: String,
+
+            event_id: String,
+
+            item_id: String,
+
+            output_index: Integer,
+
+            session_id: String,
+
+            summary_index: Integer,
+
+            turn_id: T.nilable(String),
+
+            type: Symbol
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+
+          # The summary text that was appended.
+          delta:,
+
+          # The unique ID of the event.
+          event_id:,
+
+          # The ID of the reasoning item.
+          item_id:,
+
+          # The index of the item in the turn output.
+          output_index:,
+
+          # The ID of the session associated with the event.
+          session_id:,
+
+          # The index of the summary content part.
+          summary_index:,
+
+          # The ID of the turn associated with the event, when applicable.
+          turn_id:,
+
+          # The type of the object. Always
+          # `agent.session.turn.reasoning_summary_text.delta`.
+
+          type: :"agent.session.turn.reasoning_summary_text.delta"
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              delta: String,
+              event_id: String,
+              item_id: String,
+              output_index: Integer,
+              session_id: String,
+              summary_index: Integer,
+              turn_id: T.nilable(String),
+              type: Symbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/models/beta/agent_session_turn_reasoning_summary_text_done_event.rbi

@@ -0,0 +1,122 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Beta
+
+      class AgentSessionTurnReasoningSummaryTextDoneEvent < OpenAI::Internal::Type::BaseModel
+
+        OrHash = T.type_alias do
+          T.any(
+            OpenAI::Beta::AgentSessionTurnReasoningSummaryTextDoneEvent,
+            OpenAI::Internal::AnyHash
+          )
+        end
+
+        # The unique ID of the event.
+        sig { returns(String) }
+        attr_accessor :event_id
+
+        # The ID of the reasoning item.
+        sig { returns(String) }
+        attr_accessor :item_id
+
+        # The index of the item in the turn output.
+        sig { returns(Integer) }
+        attr_accessor :output_index
+
+        # The ID of the session associated with the event.
+        sig { returns(String) }
+        attr_accessor :session_id
+
+        # The index of the summary content part.
+        sig { returns(Integer) }
+        attr_accessor :summary_index
+
+        # The complete reasoning summary text.
+        sig { returns(String) }
+        attr_accessor :text
+
+        # The ID of the turn associated with the event, when applicable.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :turn_id
+
+        # The type of the object. Always `agent.session.turn.reasoning_summary_text.done`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # Emitted when a reasoning summary content part is complete.
+        sig do
+          params(
+
+            event_id: String,
+
+            item_id: String,
+
+            output_index: Integer,
+
+            session_id: String,
+
+            summary_index: Integer,
+
+            text: String,
+
+            turn_id: T.nilable(String),
+
+            type: Symbol
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+
+          # The unique ID of the event.
+          event_id:,
+
+          # The ID of the reasoning item.
+          item_id:,
+
+          # The index of the item in the turn output.
+          output_index:,
+
+          # The ID of the session associated with the event.
+          session_id:,
+
+          # The index of the summary content part.
+          summary_index:,
+
+          # The complete reasoning summary text.
+          text:,
+
+          # The ID of the turn associated with the event, when applicable.
+          turn_id:,
+
+          # The type of the object. Always `agent.session.turn.reasoning_summary_text.done`.
+
+          type: :"agent.session.turn.reasoning_summary_text.done"
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              event_id: String,
+              item_id: String,
+              output_index: Integer,
+              session_id: String,
+              summary_index: Integer,
+              text: String,
+              turn_id: T.nilable(String),
+              type: Symbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/models/beta/agent_text.rbi

@@ -0,0 +1,75 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Beta
+
+      class AgentText < OpenAI::Internal::Type::BaseModel
+
+        OrHash = T.type_alias do
+          T.any(
+            OpenAI::Beta::AgentText,
+            OpenAI::Internal::AnyHash
+          )
+        end
+
+        # The effective output format. Defaults to ordinary text.
+        sig { returns(OpenAI::Beta::TextFormat::Variants) }
+        attr_accessor :format_
+
+        # The amount of text produced by the agent. Defaults to `medium`.
+        sig { returns(OpenAI::Beta::AgentText::Verbosity::TaggedSymbol) }
+        attr_accessor :verbosity
+
+        # The text configuration used by an agent.
+        sig do
+          params(
+
+            format_: T.any(OpenAI::Beta::TextFormat::Text::OrHash, OpenAI::Beta::TextFormat::JSONSchema::OrHash),
+
+            verbosity: OpenAI::Beta::AgentText::Verbosity::OrSymbol
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+
+          # The effective output format. Defaults to ordinary text.
+          format_:,
+
+          # The amount of text produced by the agent. Defaults to `medium`.
+
+          verbosity:
+        )
+        end
+
+        sig do
+          override.returns(
+            {format_: OpenAI::Beta::TextFormat::Variants, verbosity: OpenAI::Beta::AgentText::Verbosity::TaggedSymbol}
+          )
+        end
+        def to_hash
+        end
+
+        # The amount of text produced by the agent. Defaults to `medium`.
+        module Verbosity
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::Beta::AgentText::Verbosity) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          LOW = T.let(:low, OpenAI::Beta::AgentText::Verbosity::TaggedSymbol)
+          MEDIUM = T.let(:medium, OpenAI::Beta::AgentText::Verbosity::TaggedSymbol)
+          HIGH = T.let(:high, OpenAI::Beta::AgentText::Verbosity::TaggedSymbol)
+
+          sig { override.returns(T::Array[OpenAI::Beta::AgentText::Verbosity::TaggedSymbol]) }
+          def self.values
+          end
+        end
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/models/beta/agent_text_param.rbi

@@ -0,0 +1,87 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Beta
+
+      class AgentTextParam < OpenAI::Internal::Type::BaseModel
+
+        OrHash = T.type_alias do
+          T.any(
+            OpenAI::Beta::AgentTextParam,
+            OpenAI::Internal::AnyHash
+          )
+        end
+
+        # The output format for generated text.
+        sig {
+          returns(T.nilable(T.any(OpenAI::Beta::TextFormatParam::Text, OpenAI::Beta::TextFormatParam::JSONSchema)))
+        }
+        attr_accessor :format_
+
+        # The amount of text the model should produce.
+        sig { returns(T.nilable(OpenAI::Beta::AgentTextParam::Verbosity::OrSymbol)) }
+        attr_accessor :verbosity
+
+        # Configuration for text generated by the agent.
+        sig do
+          params(
+
+            format_: T.nilable(
+              T.any(OpenAI::Beta::TextFormatParam::Text::OrHash, OpenAI::Beta::TextFormatParam::JSONSchema::OrHash)
+            ),
+
+            verbosity: T.nilable(OpenAI::Beta::AgentTextParam::Verbosity::OrSymbol)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+
+          # The output format for generated text.
+          format_: nil,
+
+          # The amount of text the model should produce.
+
+          verbosity: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              format_: T.nilable(T.any(OpenAI::Beta::TextFormatParam::Text, OpenAI::Beta::TextFormatParam::JSONSchema)),
+              verbosity: T.nilable(OpenAI::Beta::AgentTextParam::Verbosity::OrSymbol)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The amount of text the model should produce.
+        module Verbosity
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::Beta::AgentTextParam::Verbosity) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          # Produces less text.
+          LOW = T.let(:low, OpenAI::Beta::AgentTextParam::Verbosity::TaggedSymbol)
+
+          # Uses the default amount of text.
+          MEDIUM = T.let(:medium, OpenAI::Beta::AgentTextParam::Verbosity::TaggedSymbol)
+
+          # Produces more text.
+          HIGH = T.let(:high, OpenAI::Beta::AgentTextParam::Verbosity::TaggedSymbol)
+
+          sig { override.returns(T::Array[OpenAI::Beta::AgentTextParam::Verbosity::TaggedSymbol]) }
+          def self.values
+          end
+        end
+
+      end
+
+    end
+
+  end
+end