openai 0.89.0 → 0.90.0

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

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class AgentSessionTurnOutputTextDeltaEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute content_index
+        #   The index of the content part in the message.
+        #
+        #   @return [Integer]
+        required :content_index, Integer
+
+        # @!attribute delta
+        #   The text that was appended.
+        #
+        #   @return [String]
+        required :delta, String
+
+        # @!attribute event_id
+        #   The unique ID of the event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute item_id
+        #   The ID of the message item.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the item in the turn output.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute session_id
+        #   The ID of the session associated with the event.
+        #
+        #   @return [String]
+        required :session_id, String
+
+        # @!attribute turn_id
+        #   The ID of the turn associated with the event, when applicable.
+        #
+        #   @return [String, nil]
+        required :turn_id, String, nil?: true
+
+        # @!attribute type
+        #   The type of the object. Always `agent.session.turn.output_text.delta`.
+        #
+        #   @return [Symbol, :"agent.session.turn.output_text.delta"]
+        required :type, const: :"agent.session.turn.output_text.delta"
+
+        # @!method initialize(content_index:, delta:, event_id:, item_id:, output_index:, session_id:, turn_id:, type: :"agent.session.turn.output_text.delta")
+        #   Emitted when text is appended to an output text content part.
+        #
+        #   @param content_index [Integer]
+        #     The index of the content part in the message.
+        #
+        #   @param delta [String]
+        #     The text that was appended.
+        #
+        #   @param event_id [String]
+        #     The unique ID of the event.
+        #
+        #   @param item_id [String]
+        #     The ID of the message item.
+        #
+        #   @param output_index [Integer]
+        #     The index of the item in the turn output.
+        #
+        #   @param session_id [String]
+        #     The ID of the session associated with the event.
+        #
+        #   @param turn_id [String, nil]
+        #     The ID of the turn associated with the event, when applicable.
+        #
+        #   @param type [Symbol, :"agent.session.turn.output_text.delta"]
+        #     The type of the object. Always `agent.session.turn.output_text.delta`.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class AgentSessionTurnOutputTextDoneEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute content_index
+        #   The index of the content part in the message.
+        #
+        #   @return [Integer]
+        required :content_index, Integer
+
+        # @!attribute event_id
+        #   The unique ID of the event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute item_id
+        #   The ID of the message item.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the item in the turn output.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute session_id
+        #   The ID of the session associated with the event.
+        #
+        #   @return [String]
+        required :session_id, String
+
+        # @!attribute text
+        #   The complete output text.
+        #
+        #   @return [String]
+        required :text, String
+
+        # @!attribute turn_id
+        #   The ID of the turn associated with the event, when applicable.
+        #
+        #   @return [String, nil]
+        required :turn_id, String, nil?: true
+
+        # @!attribute type
+        #   The type of the object. Always `agent.session.turn.output_text.done`.
+        #
+        #   @return [Symbol, :"agent.session.turn.output_text.done"]
+        required :type, const: :"agent.session.turn.output_text.done"
+
+        # @!method initialize(content_index:, event_id:, item_id:, output_index:, session_id:, text:, turn_id:, type: :"agent.session.turn.output_text.done")
+        #   Emitted when an output text content part is complete.
+        #
+        #   @param content_index [Integer]
+        #     The index of the content part in the message.
+        #
+        #   @param event_id [String]
+        #     The unique ID of the event.
+        #
+        #   @param item_id [String]
+        #     The ID of the message item.
+        #
+        #   @param output_index [Integer]
+        #     The index of the item in the turn output.
+        #
+        #   @param session_id [String]
+        #     The ID of the session associated with the event.
+        #
+        #   @param text [String]
+        #     The complete output text.
+        #
+        #   @param turn_id [String, nil]
+        #     The ID of the turn associated with the event, when applicable.
+        #
+        #   @param type [Symbol, :"agent.session.turn.output_text.done"]
+        #     The type of the object. Always `agent.session.turn.output_text.done`.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class AgentSessionTurnReasoningSummaryPartAddedEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute event_id
+        #   The unique ID of the event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute item_id
+        #   The ID of the reasoning item.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the item in the turn output.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute part
+        #   The initial summary part.
+        #
+        #   @return [OpenAI::Models::Beta::SummaryText]
+        required :part, -> { OpenAI::Beta::SummaryText }
+
+        # @!attribute session_id
+        #   The ID of the session associated with the event.
+        #
+        #   @return [String]
+        required :session_id, String
+
+        # @!attribute summary_index
+        #   The index of the summary content part.
+        #
+        #   @return [Integer]
+        required :summary_index, Integer
+
+        # @!attribute turn_id
+        #   The ID of the turn associated with the event, when applicable.
+        #
+        #   @return [String, nil]
+        required :turn_id, String, nil?: true
+
+        # @!attribute type
+        #   The type of the object. Always
+        #   `agent.session.turn.reasoning_summary_part.added`.
+        #
+        #   @return [Symbol, :"agent.session.turn.reasoning_summary_part.added"]
+        required :type, const: :"agent.session.turn.reasoning_summary_part.added"
+
+        # @!method initialize(event_id:, item_id:, output_index:, part:, session_id:, summary_index:, turn_id:, type: :"agent.session.turn.reasoning_summary_part.added")
+        #   Emitted when a reasoning summary content part is added.
+        #
+        #   @param event_id [String]
+        #     The unique ID of the event.
+        #
+        #   @param item_id [String]
+        #     The ID of the reasoning item.
+        #
+        #   @param output_index [Integer]
+        #     The index of the item in the turn output.
+        #
+        #   @param part [OpenAI::Models::Beta::SummaryText]
+        #     The initial summary part.
+        #
+        #   @param session_id [String]
+        #     The ID of the session associated with the event.
+        #
+        #   @param summary_index [Integer]
+        #     The index of the summary content part.
+        #
+        #   @param turn_id [String, nil]
+        #     The ID of the turn associated with the event, when applicable.
+        #
+        #   @param type [Symbol, :"agent.session.turn.reasoning_summary_part.added"]
+        #     The type of the object. Always
+        #     `agent.session.turn.reasoning_summary_part.added`.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class AgentSessionTurnReasoningSummaryPartDoneEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute event_id
+        #   The unique ID of the event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute item_id
+        #   The ID of the reasoning item.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the item in the turn output.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute part
+        #   The completed summary part.
+        #
+        #   @return [OpenAI::Models::Beta::SummaryText]
+        required :part, -> { OpenAI::Beta::SummaryText }
+
+        # @!attribute session_id
+        #   The ID of the session associated with the event.
+        #
+        #   @return [String]
+        required :session_id, String
+
+        # @!attribute status
+        #   Present as `incomplete` when summary generation was interrupted.
+        #
+        #   @return [Symbol, :incomplete, nil]
+        required :status, const: :incomplete, nil?: true
+
+        # @!attribute summary_index
+        #   The index of the summary part.
+        #
+        #   @return [Integer]
+        required :summary_index, Integer
+
+        # @!attribute turn_id
+        #   The ID of the turn associated with the event, when applicable.
+        #
+        #   @return [String, nil]
+        required :turn_id, String, nil?: true
+
+        # @!attribute type
+        #   The type of the object. Always `agent.session.turn.reasoning_summary_part.done`.
+        #
+        #   @return [Symbol, :"agent.session.turn.reasoning_summary_part.done"]
+        required :type, const: :"agent.session.turn.reasoning_summary_part.done"
+
+        # @!method initialize(event_id:, item_id:, output_index:, part:, session_id:, summary_index:, turn_id:, status: :incomplete, type: :"agent.session.turn.reasoning_summary_part.done")
+        #   Emitted when a reasoning summary part is complete.
+        #
+        #   @param event_id [String]
+        #     The unique ID of the event.
+        #
+        #   @param item_id [String]
+        #     The ID of the reasoning item.
+        #
+        #   @param output_index [Integer]
+        #     The index of the item in the turn output.
+        #
+        #   @param part [OpenAI::Models::Beta::SummaryText]
+        #     The completed summary part.
+        #
+        #   @param session_id [String]
+        #     The ID of the session associated with the event.
+        #
+        #   @param summary_index [Integer]
+        #     The index of the summary part.
+        #
+        #   @param turn_id [String, nil]
+        #     The ID of the turn associated with the event, when applicable.
+        #
+        #   @param status [Symbol, :incomplete, nil]
+        #     Present as `incomplete` when summary generation was interrupted.
+        #
+        #   @param type [Symbol, :"agent.session.turn.reasoning_summary_part.done"]
+        #     The type of the object. Always `agent.session.turn.reasoning_summary_part.done`.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class AgentSessionTurnReasoningSummaryTextDeltaEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute delta
+        #   The summary text that was appended.
+        #
+        #   @return [String]
+        required :delta, String
+
+        # @!attribute event_id
+        #   The unique ID of the event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute item_id
+        #   The ID of the reasoning item.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the item in the turn output.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute session_id
+        #   The ID of the session associated with the event.
+        #
+        #   @return [String]
+        required :session_id, String
+
+        # @!attribute summary_index
+        #   The index of the summary content part.
+        #
+        #   @return [Integer]
+        required :summary_index, Integer
+
+        # @!attribute turn_id
+        #   The ID of the turn associated with the event, when applicable.
+        #
+        #   @return [String, nil]
+        required :turn_id, String, nil?: true
+
+        # @!attribute type
+        #   The type of the object. Always
+        #   `agent.session.turn.reasoning_summary_text.delta`.
+        #
+        #   @return [Symbol, :"agent.session.turn.reasoning_summary_text.delta"]
+        required :type, const: :"agent.session.turn.reasoning_summary_text.delta"
+
+        # @!method initialize(delta:, event_id:, item_id:, output_index:, session_id:, summary_index:, turn_id:, type: :"agent.session.turn.reasoning_summary_text.delta")
+        #   Emitted when text is appended to a reasoning summary.
+        #
+        #   @param delta [String]
+        #     The summary text that was appended.
+        #
+        #   @param event_id [String]
+        #     The unique ID of the event.
+        #
+        #   @param item_id [String]
+        #     The ID of the reasoning item.
+        #
+        #   @param output_index [Integer]
+        #     The index of the item in the turn output.
+        #
+        #   @param session_id [String]
+        #     The ID of the session associated with the event.
+        #
+        #   @param summary_index [Integer]
+        #     The index of the summary content part.
+        #
+        #   @param turn_id [String, nil]
+        #     The ID of the turn associated with the event, when applicable.
+        #
+        #   @param type [Symbol, :"agent.session.turn.reasoning_summary_text.delta"]
+        #     The type of the object. Always
+        #     `agent.session.turn.reasoning_summary_text.delta`.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class AgentSessionTurnReasoningSummaryTextDoneEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute event_id
+        #   The unique ID of the event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute item_id
+        #   The ID of the reasoning item.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the item in the turn output.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute session_id
+        #   The ID of the session associated with the event.
+        #
+        #   @return [String]
+        required :session_id, String
+
+        # @!attribute summary_index
+        #   The index of the summary content part.
+        #
+        #   @return [Integer]
+        required :summary_index, Integer
+
+        # @!attribute text
+        #   The complete reasoning summary text.
+        #
+        #   @return [String]
+        required :text, String
+
+        # @!attribute turn_id
+        #   The ID of the turn associated with the event, when applicable.
+        #
+        #   @return [String, nil]
+        required :turn_id, String, nil?: true
+
+        # @!attribute type
+        #   The type of the object. Always `agent.session.turn.reasoning_summary_text.done`.
+        #
+        #   @return [Symbol, :"agent.session.turn.reasoning_summary_text.done"]
+        required :type, const: :"agent.session.turn.reasoning_summary_text.done"
+
+        # @!method initialize(event_id:, item_id:, output_index:, session_id:, summary_index:, text:, turn_id:, type: :"agent.session.turn.reasoning_summary_text.done")
+        #   Emitted when a reasoning summary content part is complete.
+        #
+        #   @param event_id [String]
+        #     The unique ID of the event.
+        #
+        #   @param item_id [String]
+        #     The ID of the reasoning item.
+        #
+        #   @param output_index [Integer]
+        #     The index of the item in the turn output.
+        #
+        #   @param session_id [String]
+        #     The ID of the session associated with the event.
+        #
+        #   @param summary_index [Integer]
+        #     The index of the summary content part.
+        #
+        #   @param text [String]
+        #     The complete reasoning summary text.
+        #
+        #   @param turn_id [String, nil]
+        #     The ID of the turn associated with the event, when applicable.
+        #
+        #   @param type [Symbol, :"agent.session.turn.reasoning_summary_text.done"]
+        #     The type of the object. Always `agent.session.turn.reasoning_summary_text.done`.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class AgentText < OpenAI::Internal::Type::BaseModel
+        # @!attribute format_
+        #   The effective output format. Defaults to ordinary text.
+        #
+        #   @return [OpenAI::Models::Beta::TextFormat::Text, OpenAI::Models::Beta::TextFormat::JSONSchema]
+        required :format_, union: -> { OpenAI::Beta::TextFormat }, api_name: :format
+
+        # @!attribute verbosity
+        #   The amount of text produced by the agent. Defaults to `medium`.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::AgentText::Verbosity]
+        required :verbosity, enum: -> { OpenAI::Beta::AgentText::Verbosity }
+
+        # @!method initialize(format_:, verbosity:)
+        #   The text configuration used by an agent.
+        #
+        #   @param format_ [OpenAI::Models::Beta::TextFormat::Text, OpenAI::Models::Beta::TextFormat::JSONSchema]
+        #     The effective output format. Defaults to ordinary text.
+        #
+        #   @param verbosity [Symbol, OpenAI::Models::Beta::AgentText::Verbosity]
+        #     The amount of text produced by the agent. Defaults to `medium`.
+
+        # The amount of text produced by the agent. Defaults to `medium`.
+        #
+        # @see OpenAI::Models::Beta::AgentText#verbosity
+        module Verbosity
+          extend OpenAI::Internal::Type::Enum
+
+          LOW = :low
+          MEDIUM = :medium
+          HIGH = :high
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class AgentTextParam < OpenAI::Internal::Type::BaseModel
+        # @!attribute format_
+        #   The output format for generated text.
+        #
+        #   @return [OpenAI::Models::Beta::TextFormatParam::Text, OpenAI::Models::Beta::TextFormatParam::JSONSchema, nil]
+        optional :format_, union: -> { OpenAI::Beta::TextFormatParam }, api_name: :format, nil?: true
+
+        # @!attribute verbosity
+        #   The amount of text the model should produce.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::AgentTextParam::Verbosity, nil]
+        optional :verbosity, enum: -> { OpenAI::Beta::AgentTextParam::Verbosity }, nil?: true
+
+        # @!method initialize(format_: nil, verbosity: nil)
+        #   Configuration for text generated by the agent.
+        #
+        #   @param format_ [OpenAI::Models::Beta::TextFormatParam::Text, OpenAI::Models::Beta::TextFormatParam::JSONSchema, nil]
+        #     The output format for generated text.
+        #
+        #   @param verbosity [Symbol, OpenAI::Models::Beta::AgentTextParam::Verbosity, nil]
+        #     The amount of text the model should produce.
+
+        # The amount of text the model should produce.
+        #
+        # @see OpenAI::Models::Beta::AgentTextParam#verbosity
+        module Verbosity
+          extend OpenAI::Internal::Type::Enum
+
+          # Produces less text.
+          LOW = :low
+
+          # Uses the default amount of text.
+          MEDIUM = :medium
+
+          # Produces more text.
+          HIGH = :high
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end