openai 0.68.0 → 0.69.0

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

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseReasoningSummaryTextDeltaEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute delta
+        #   The text delta that was added to the summary.
+        #
+        #   @return [String]
+        required :delta, String
+
+        # @!attribute item_id
+        #   The ID of the item this summary text delta is associated with.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the output item this summary text delta is associated with.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute sequence_number
+        #   The sequence number of this event.
+        #
+        #   @return [Integer]
+        required :sequence_number, Integer
+
+        # @!attribute summary_index
+        #   The index of the summary part within the reasoning summary.
+        #
+        #   @return [Integer]
+        required :summary_index, Integer
+
+        # @!attribute type
+        #   The type of the event. Always `response.reasoning_summary_text.delta`.
+        #
+        #   @return [Symbol, :"response.reasoning_summary_text.delta"]
+        required :type, const: :"response.reasoning_summary_text.delta"
+
+        # @!attribute agent
+        #   The agent that owns this multi-agent streaming event.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseReasoningSummaryTextDeltaEvent::Agent, nil]
+        optional :agent, -> { OpenAI::Beta::BetaResponseReasoningSummaryTextDeltaEvent::Agent }, nil?: true
+
+        # @!method initialize(delta:, item_id:, output_index:, sequence_number:, summary_index:, agent: nil, type: :"response.reasoning_summary_text.delta")
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Beta::BetaResponseReasoningSummaryTextDeltaEvent} for more
+        #   details.
+        #
+        #   Emitted when a delta is added to a reasoning summary text.
+        #
+        #   @param delta [String] The text delta that was added to the summary.
+        #
+        #   @param item_id [String] The ID of the item this summary text delta is associated with.
+        #
+        #   @param output_index [Integer] The index of the output item this summary text delta is associated with.
+        #
+        #   @param sequence_number [Integer] The sequence number of this event.
+        #
+        #   @param summary_index [Integer] The index of the summary part within the reasoning summary.
+        #
+        #   @param agent [OpenAI::Models::Beta::BetaResponseReasoningSummaryTextDeltaEvent::Agent, nil] The agent that owns this multi-agent streaming event.
+        #
+        #   @param type [Symbol, :"response.reasoning_summary_text.delta"] The type of the event. Always `response.reasoning_summary_text.delta`.
+
+        # @see OpenAI::Models::Beta::BetaResponseReasoningSummaryTextDeltaEvent#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
+
+    BetaResponseReasoningSummaryTextDeltaEvent = Beta::BetaResponseReasoningSummaryTextDeltaEvent
+  end
+end

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

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseReasoningSummaryTextDoneEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute item_id
+        #   The ID of the item this summary text is associated with.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the output item this summary text is associated with.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute sequence_number
+        #   The sequence number of this event.
+        #
+        #   @return [Integer]
+        required :sequence_number, Integer
+
+        # @!attribute summary_index
+        #   The index of the summary part within the reasoning summary.
+        #
+        #   @return [Integer]
+        required :summary_index, Integer
+
+        # @!attribute text
+        #   The full text of the completed reasoning summary.
+        #
+        #   @return [String]
+        required :text, String
+
+        # @!attribute type
+        #   The type of the event. Always `response.reasoning_summary_text.done`.
+        #
+        #   @return [Symbol, :"response.reasoning_summary_text.done"]
+        required :type, const: :"response.reasoning_summary_text.done"
+
+        # @!attribute agent
+        #   The agent that owns this multi-agent streaming event.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseReasoningSummaryTextDoneEvent::Agent, nil]
+        optional :agent, -> { OpenAI::Beta::BetaResponseReasoningSummaryTextDoneEvent::Agent }, nil?: true
+
+        # @!method initialize(item_id:, output_index:, sequence_number:, summary_index:, text:, agent: nil, type: :"response.reasoning_summary_text.done")
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Beta::BetaResponseReasoningSummaryTextDoneEvent} for more
+        #   details.
+        #
+        #   Emitted when a reasoning summary text is completed.
+        #
+        #   @param item_id [String] The ID of the item this summary text is associated with.
+        #
+        #   @param output_index [Integer] The index of the output item this summary text is associated with.
+        #
+        #   @param sequence_number [Integer] The sequence number of this event.
+        #
+        #   @param summary_index [Integer] The index of the summary part within the reasoning summary.
+        #
+        #   @param text [String] The full text of the completed reasoning summary.
+        #
+        #   @param agent [OpenAI::Models::Beta::BetaResponseReasoningSummaryTextDoneEvent::Agent, nil] The agent that owns this multi-agent streaming event.
+        #
+        #   @param type [Symbol, :"response.reasoning_summary_text.done"] The type of the event. Always `response.reasoning_summary_text.done`.
+
+        # @see OpenAI::Models::Beta::BetaResponseReasoningSummaryTextDoneEvent#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
+
+    BetaResponseReasoningSummaryTextDoneEvent = Beta::BetaResponseReasoningSummaryTextDoneEvent
+  end
+end

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

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseReasoningTextDeltaEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute content_index
+        #   The index of the reasoning content part this delta is associated with.
+        #
+        #   @return [Integer]
+        required :content_index, Integer
+
+        # @!attribute delta
+        #   The text delta that was added to the reasoning content.
+        #
+        #   @return [String]
+        required :delta, String
+
+        # @!attribute item_id
+        #   The ID of the item this reasoning text delta is associated with.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the output item this reasoning text delta is associated with.
+        #
+        #   @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.reasoning_text.delta`.
+        #
+        #   @return [Symbol, :"response.reasoning_text.delta"]
+        required :type, const: :"response.reasoning_text.delta"
+
+        # @!attribute agent
+        #   The agent that owns this multi-agent streaming event.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseReasoningTextDeltaEvent::Agent, nil]
+        optional :agent, -> { OpenAI::Beta::BetaResponseReasoningTextDeltaEvent::Agent }, nil?: true
+
+        # @!method initialize(content_index:, delta:, item_id:, output_index:, sequence_number:, agent: nil, type: :"response.reasoning_text.delta")
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Beta::BetaResponseReasoningTextDeltaEvent} for more details.
+        #
+        #   Emitted when a delta is added to a reasoning text.
+        #
+        #   @param content_index [Integer] The index of the reasoning content part this delta is associated with.
+        #
+        #   @param delta [String] The text delta that was added to the reasoning content.
+        #
+        #   @param item_id [String] The ID of the item this reasoning text delta is associated with.
+        #
+        #   @param output_index [Integer] The index of the output item this reasoning text delta is associated with.
+        #
+        #   @param sequence_number [Integer] The sequence number of this event.
+        #
+        #   @param agent [OpenAI::Models::Beta::BetaResponseReasoningTextDeltaEvent::Agent, nil] The agent that owns this multi-agent streaming event.
+        #
+        #   @param type [Symbol, :"response.reasoning_text.delta"] The type of the event. Always `response.reasoning_text.delta`.
+
+        # @see OpenAI::Models::Beta::BetaResponseReasoningTextDeltaEvent#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
+
+    BetaResponseReasoningTextDeltaEvent = Beta::BetaResponseReasoningTextDeltaEvent
+  end
+end

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

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseReasoningTextDoneEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute content_index
+        #   The index of the reasoning content part.
+        #
+        #   @return [Integer]
+        required :content_index, Integer
+
+        # @!attribute item_id
+        #   The ID of the item this reasoning text is associated with.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the output item this reasoning text is associated with.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute sequence_number
+        #   The sequence number of this event.
+        #
+        #   @return [Integer]
+        required :sequence_number, Integer
+
+        # @!attribute text
+        #   The full text of the completed reasoning content.
+        #
+        #   @return [String]
+        required :text, String
+
+        # @!attribute type
+        #   The type of the event. Always `response.reasoning_text.done`.
+        #
+        #   @return [Symbol, :"response.reasoning_text.done"]
+        required :type, const: :"response.reasoning_text.done"
+
+        # @!attribute agent
+        #   The agent that owns this multi-agent streaming event.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseReasoningTextDoneEvent::Agent, nil]
+        optional :agent, -> { OpenAI::Beta::BetaResponseReasoningTextDoneEvent::Agent }, nil?: true
+
+        # @!method initialize(content_index:, item_id:, output_index:, sequence_number:, text:, agent: nil, type: :"response.reasoning_text.done")
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Beta::BetaResponseReasoningTextDoneEvent} for more details.
+        #
+        #   Emitted when a reasoning text is completed.
+        #
+        #   @param content_index [Integer] The index of the reasoning content part.
+        #
+        #   @param item_id [String] The ID of the item this reasoning text is associated with.
+        #
+        #   @param output_index [Integer] The index of the output item this reasoning text is associated with.
+        #
+        #   @param sequence_number [Integer] The sequence number of this event.
+        #
+        #   @param text [String] The full text of the completed reasoning content.
+        #
+        #   @param agent [OpenAI::Models::Beta::BetaResponseReasoningTextDoneEvent::Agent, nil] The agent that owns this multi-agent streaming event.
+        #
+        #   @param type [Symbol, :"response.reasoning_text.done"] The type of the event. Always `response.reasoning_text.done`.
+
+        # @see OpenAI::Models::Beta::BetaResponseReasoningTextDoneEvent#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
+
+    BetaResponseReasoningTextDoneEvent = Beta::BetaResponseReasoningTextDoneEvent
+  end
+end

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

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseRefusalDeltaEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute content_index
+        #   The index of the content part that the refusal text is added to.
+        #
+        #   @return [Integer]
+        required :content_index, Integer
+
+        # @!attribute delta
+        #   The refusal text that is added.
+        #
+        #   @return [String]
+        required :delta, String
+
+        # @!attribute item_id
+        #   The ID of the output item that the refusal text is added to.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the output item that the refusal text is added to.
+        #
+        #   @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.refusal.delta`.
+        #
+        #   @return [Symbol, :"response.refusal.delta"]
+        required :type, const: :"response.refusal.delta"
+
+        # @!attribute agent
+        #   The agent that owns this multi-agent streaming event.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseRefusalDeltaEvent::Agent, nil]
+        optional :agent, -> { OpenAI::Beta::BetaResponseRefusalDeltaEvent::Agent }, nil?: true
+
+        # @!method initialize(content_index:, delta:, item_id:, output_index:, sequence_number:, agent: nil, type: :"response.refusal.delta")
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Beta::BetaResponseRefusalDeltaEvent} for more details.
+        #
+        #   Emitted when there is a partial refusal text.
+        #
+        #   @param content_index [Integer] The index of the content part that the refusal text is added to.
+        #
+        #   @param delta [String] The refusal text that is added.
+        #
+        #   @param item_id [String] The ID of the output item that the refusal text is added to.
+        #
+        #   @param output_index [Integer] The index of the output item that the refusal text is added to.
+        #
+        #   @param sequence_number [Integer] The sequence number of this event.
+        #
+        #   @param agent [OpenAI::Models::Beta::BetaResponseRefusalDeltaEvent::Agent, nil] The agent that owns this multi-agent streaming event.
+        #
+        #   @param type [Symbol, :"response.refusal.delta"] The type of the event. Always `response.refusal.delta`.
+
+        # @see OpenAI::Models::Beta::BetaResponseRefusalDeltaEvent#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
+
+    BetaResponseRefusalDeltaEvent = Beta::BetaResponseRefusalDeltaEvent
+  end
+end

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

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseRefusalDoneEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute content_index
+        #   The index of the content part that the refusal text is finalized.
+        #
+        #   @return [Integer]
+        required :content_index, Integer
+
+        # @!attribute item_id
+        #   The ID of the output item that the refusal text is finalized.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the output item that the refusal text is finalized.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute refusal
+        #   The refusal text that is finalized.
+        #
+        #   @return [String]
+        required :refusal, String
+
+        # @!attribute sequence_number
+        #   The sequence number of this event.
+        #
+        #   @return [Integer]
+        required :sequence_number, Integer
+
+        # @!attribute type
+        #   The type of the event. Always `response.refusal.done`.
+        #
+        #   @return [Symbol, :"response.refusal.done"]
+        required :type, const: :"response.refusal.done"
+
+        # @!attribute agent
+        #   The agent that owns this multi-agent streaming event.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseRefusalDoneEvent::Agent, nil]
+        optional :agent, -> { OpenAI::Beta::BetaResponseRefusalDoneEvent::Agent }, nil?: true
+
+        # @!method initialize(content_index:, item_id:, output_index:, refusal:, sequence_number:, agent: nil, type: :"response.refusal.done")
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Beta::BetaResponseRefusalDoneEvent} for more details.
+        #
+        #   Emitted when refusal text is finalized.
+        #
+        #   @param content_index [Integer] The index of the content part that the refusal text is finalized.
+        #
+        #   @param item_id [String] The ID of the output item that the refusal text is finalized.
+        #
+        #   @param output_index [Integer] The index of the output item that the refusal text is finalized.
+        #
+        #   @param refusal [String] The refusal text that is finalized.
+        #
+        #   @param sequence_number [Integer] The sequence number of this event.
+        #
+        #   @param agent [OpenAI::Models::Beta::BetaResponseRefusalDoneEvent::Agent, nil] The agent that owns this multi-agent streaming event.
+        #
+        #   @param type [Symbol, :"response.refusal.done"] The type of the event. Always `response.refusal.done`.
+
+        # @see OpenAI::Models::Beta::BetaResponseRefusalDoneEvent#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
+
+    BetaResponseRefusalDoneEvent = Beta::BetaResponseRefusalDoneEvent
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # The status of the response generation. One of `completed`, `failed`,
+      # `in_progress`, `cancelled`, `queued`, or `incomplete`.
+      module BetaResponseStatus
+        extend OpenAI::Internal::Type::Enum
+
+        COMPLETED = :completed
+        FAILED = :failed
+        IN_PROGRESS = :in_progress
+        CANCELLED = :cancelled
+        QUEUED = :queued
+        INCOMPLETE = :incomplete
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+
+    BetaResponseStatus = Beta::BetaResponseStatus
+  end
+end