openai 0.67.0 → 0.69.0

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

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseOutputTextAnnotationAddedEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute annotation
+        #   The annotation object being added. (See annotation schema for details.)
+        #
+        #   @return [Object]
+        required :annotation, OpenAI::Internal::Type::Unknown
+
+        # @!attribute annotation_index
+        #   The index of the annotation within the content part.
+        #
+        #   @return [Integer]
+        required :annotation_index, Integer
+
+        # @!attribute content_index
+        #   The index of the content part within the output item.
+        #
+        #   @return [Integer]
+        required :content_index, Integer
+
+        # @!attribute item_id
+        #   The unique identifier of the item to which the annotation is being added.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the output item in the response's output array.
+        #
+        #   @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.output_text.annotation.added'.
+        #
+        #   @return [Symbol, :"response.output_text.annotation.added"]
+        required :type, const: :"response.output_text.annotation.added"
+
+        # @!attribute agent
+        #   The agent that owns this multi-agent streaming event.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent::Agent, nil]
+        optional :agent, -> { OpenAI::Beta::BetaResponseOutputTextAnnotationAddedEvent::Agent }, nil?: true
+
+        # @!method initialize(annotation:, annotation_index:, content_index:, item_id:, output_index:, sequence_number:, agent: nil, type: :"response.output_text.annotation.added")
+        #   Emitted when an annotation is added to output text content.
+        #
+        #   @param annotation [Object] The annotation object being added. (See annotation schema for details.)
+        #
+        #   @param annotation_index [Integer] The index of the annotation within the content part.
+        #
+        #   @param content_index [Integer] The index of the content part within the output item.
+        #
+        #   @param item_id [String] The unique identifier of the item to which the annotation is being added.
+        #
+        #   @param output_index [Integer] The index of the output item in the response's output array.
+        #
+        #   @param sequence_number [Integer] The sequence number of this event.
+        #
+        #   @param agent [OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent::Agent, nil] The agent that owns this multi-agent streaming event.
+        #
+        #   @param type [Symbol, :"response.output_text.annotation.added"] The type of the event. Always 'response.output_text.annotation.added'.
+
+        # @see OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent#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
+
+    BetaResponseOutputTextAnnotationAddedEvent = Beta::BetaResponseOutputTextAnnotationAddedEvent
+  end
+end

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponsePrompt < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique identifier of the prompt template to use.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute variables
+        #   Optional map of values to substitute in for variables in your prompt. The
+        #   substitution values can either be strings, or other Response input types like
+        #   images or files.
+        #
+        #   @return [Hash{Symbol=>String, OpenAI::Models::Beta::BetaResponseInputText, OpenAI::Models::Beta::BetaResponseInputImage, OpenAI::Models::Beta::BetaResponseInputFile}, nil]
+        optional :variables,
+                 -> { OpenAI::Internal::Type::HashOf[union: OpenAI::Beta::BetaResponsePrompt::Variable] },
+                 nil?: true
+
+        # @!attribute version
+        #   Optional version of the prompt template.
+        #
+        #   @return [String, nil]
+        optional :version, String, nil?: true
+
+        # @!method initialize(id:, variables: nil, version: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Beta::BetaResponsePrompt} for more details.
+        #
+        #   Reference to a prompt template and its variables.
+        #   [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).
+        #
+        #   @param id [String] The unique identifier of the prompt template to use.
+        #
+        #   @param variables [Hash{Symbol=>String, OpenAI::Models::Beta::BetaResponseInputText, OpenAI::Models::Beta::BetaResponseInputImage, OpenAI::Models::Beta::BetaResponseInputFile}, nil] Optional map of values to substitute in for variables in your
+        #
+        #   @param version [String, nil] Optional version of the prompt template.
+
+        # A text input to the model.
+        module Variable
+          extend OpenAI::Internal::Type::Union
+
+          variant String
+
+          # A text input to the model.
+          variant -> { OpenAI::Beta::BetaResponseInputText }
+
+          # An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision).
+          variant -> { OpenAI::Beta::BetaResponseInputImage }
+
+          # A file input to the model.
+          variant -> { OpenAI::Beta::BetaResponseInputFile }
+
+          # @!method self.variants
+          #   @return [Array(String, OpenAI::Models::Beta::BetaResponseInputText, OpenAI::Models::Beta::BetaResponseInputImage, OpenAI::Models::Beta::BetaResponseInputFile)]
+        end
+      end
+    end
+
+    BetaResponsePrompt = Beta::BetaResponsePrompt
+  end
+end

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseQueuedEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute response
+        #   The full response object that is queued.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponse]
+        required :response, -> { OpenAI::Beta::BetaResponse }
+
+        # @!attribute sequence_number
+        #   The sequence number for this event.
+        #
+        #   @return [Integer]
+        required :sequence_number, Integer
+
+        # @!attribute type
+        #   The type of the event. Always 'response.queued'.
+        #
+        #   @return [Symbol, :"response.queued"]
+        required :type, const: :"response.queued"
+
+        # @!attribute agent
+        #   The agent that owns this multi-agent streaming event.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseQueuedEvent::Agent, nil]
+        optional :agent, -> { OpenAI::Beta::BetaResponseQueuedEvent::Agent }, nil?: true
+
+        # @!method initialize(response:, sequence_number:, agent: nil, type: :"response.queued")
+        #   Emitted when a response is queued and waiting to be processed.
+        #
+        #   @param response [OpenAI::Models::Beta::BetaResponse] The full response object that is queued.
+        #
+        #   @param sequence_number [Integer] The sequence number for this event.
+        #
+        #   @param agent [OpenAI::Models::Beta::BetaResponseQueuedEvent::Agent, nil] The agent that owns this multi-agent streaming event.
+        #
+        #   @param type [Symbol, :"response.queued"] The type of the event. Always 'response.queued'.
+
+        # @see OpenAI::Models::Beta::BetaResponseQueuedEvent#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
+
+    BetaResponseQueuedEvent = Beta::BetaResponseQueuedEvent
+  end
+end

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

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseReasoningItem < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique identifier of the reasoning content.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute summary
+        #   Reasoning summary content.
+        #
+        #   @return [Array<OpenAI::Models::Beta::BetaResponseReasoningItem::Summary>]
+        required :summary,
+                 -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Beta::BetaResponseReasoningItem::Summary] }
+
+        # @!attribute type
+        #   The type of the object. Always `reasoning`.
+        #
+        #   @return [Symbol, :reasoning]
+        required :type, const: :reasoning
+
+        # @!attribute agent
+        #   The agent that produced this item.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseReasoningItem::Agent, nil]
+        optional :agent, -> { OpenAI::Beta::BetaResponseReasoningItem::Agent }, nil?: true
+
+        # @!attribute content
+        #   Reasoning text content.
+        #
+        #   @return [Array<OpenAI::Models::Beta::BetaResponseReasoningItem::Content>, nil]
+        optional :content,
+                 -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Beta::BetaResponseReasoningItem::Content] }
+
+        # @!attribute encrypted_content
+        #   The encrypted content of the reasoning item - populated when a response is
+        #   generated with `reasoning.encrypted_content` in the `include` parameter.
+        #
+        #   @return [String, nil]
+        optional :encrypted_content, String, nil?: true
+
+        # @!attribute status
+        #   The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+        #   Populated when items are returned via API.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::BetaResponseReasoningItem::Status, nil]
+        optional :status, enum: -> { OpenAI::Beta::BetaResponseReasoningItem::Status }
+
+        # @!method initialize(id:, summary:, agent: nil, content: nil, encrypted_content: nil, status: nil, type: :reasoning)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Beta::BetaResponseReasoningItem} for more details.
+        #
+        #   A description of the chain of thought used by a reasoning model while generating
+        #   a response. Be sure to include these items in your `input` to the Responses API
+        #   for subsequent turns of a conversation if you are manually
+        #   [managing context](https://platform.openai.com/docs/guides/conversation-state).
+        #
+        #   @param id [String] The unique identifier of the reasoning content.
+        #
+        #   @param summary [Array<OpenAI::Models::Beta::BetaResponseReasoningItem::Summary>] Reasoning summary content.
+        #
+        #   @param agent [OpenAI::Models::Beta::BetaResponseReasoningItem::Agent, nil] The agent that produced this item.
+        #
+        #   @param content [Array<OpenAI::Models::Beta::BetaResponseReasoningItem::Content>] Reasoning text content.
+        #
+        #   @param encrypted_content [String, nil] The encrypted content of the reasoning item - populated when a response is
+        #
+        #   @param status [Symbol, OpenAI::Models::Beta::BetaResponseReasoningItem::Status] The status of the item. One of `in_progress`, `completed`, or
+        #
+        #   @param type [Symbol, :reasoning] The type of the object. Always `reasoning`.
+
+        class Summary < OpenAI::Internal::Type::BaseModel
+          # @!attribute text
+          #   A summary of the reasoning output from the model so far.
+          #
+          #   @return [String]
+          required :text, String
+
+          # @!attribute type
+          #   The type of the object. Always `summary_text`.
+          #
+          #   @return [Symbol, :summary_text]
+          required :type, const: :summary_text
+
+          # @!method initialize(text:, type: :summary_text)
+          #   A summary text from the model.
+          #
+          #   @param text [String] A summary of the reasoning output from the model so far.
+          #
+          #   @param type [Symbol, :summary_text] The type of the object. Always `summary_text`.
+        end
+
+        # @see OpenAI::Models::Beta::BetaResponseReasoningItem#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 produced this item.
+          #
+          #   @param agent_name [String] The canonical name of the agent that produced this item.
+        end
+
+        class Content < OpenAI::Internal::Type::BaseModel
+          # @!attribute text
+          #   The reasoning text from the model.
+          #
+          #   @return [String]
+          required :text, String
+
+          # @!attribute type
+          #   The type of the reasoning text. Always `reasoning_text`.
+          #
+          #   @return [Symbol, :reasoning_text]
+          required :type, const: :reasoning_text
+
+          # @!method initialize(text:, type: :reasoning_text)
+          #   Reasoning text from the model.
+          #
+          #   @param text [String] The reasoning text from the model.
+          #
+          #   @param type [Symbol, :reasoning_text] The type of the reasoning text. Always `reasoning_text`.
+        end
+
+        # The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+        # Populated when items are returned via API.
+        #
+        # @see OpenAI::Models::Beta::BetaResponseReasoningItem#status
+        module Status
+          extend OpenAI::Internal::Type::Enum
+
+          IN_PROGRESS = :in_progress
+          COMPLETED = :completed
+          INCOMPLETE = :incomplete
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+
+    BetaResponseReasoningItem = Beta::BetaResponseReasoningItem
+  end
+end

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

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

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

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseReasoningSummaryPartDoneEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute item_id
+        #   The ID of the item this summary part is associated with.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the output item this summary part is associated with.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute part
+        #   The completed summary part.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseReasoningSummaryPartDoneEvent::Part]
+        required :part, -> { OpenAI::Beta::BetaResponseReasoningSummaryPartDoneEvent::Part }
+
+        # @!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_part.done`.
+        #
+        #   @return [Symbol, :"response.reasoning_summary_part.done"]
+        required :type, const: :"response.reasoning_summary_part.done"
+
+        # @!attribute agent
+        #   The agent that owns this multi-agent streaming event.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseReasoningSummaryPartDoneEvent::Agent, nil]
+        optional :agent, -> { OpenAI::Beta::BetaResponseReasoningSummaryPartDoneEvent::Agent }, nil?: true
+
+        # @!attribute status
+        #   The completion status of the summary part. Omitted when the part completed
+        #   normally and set to `incomplete` when generation was interrupted.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::BetaResponseReasoningSummaryPartDoneEvent::Status, nil]
+        optional :status, enum: -> { OpenAI::Beta::BetaResponseReasoningSummaryPartDoneEvent::Status }
+
+        # @!method initialize(item_id:, output_index:, part:, sequence_number:, summary_index:, agent: nil, status: nil, type: :"response.reasoning_summary_part.done")
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Beta::BetaResponseReasoningSummaryPartDoneEvent} for more
+        #   details.
+        #
+        #   Emitted when a reasoning summary part is completed.
+        #
+        #   @param item_id [String] The ID of the item this summary part is associated with.
+        #
+        #   @param output_index [Integer] The index of the output item this summary part is associated with.
+        #
+        #   @param part [OpenAI::Models::Beta::BetaResponseReasoningSummaryPartDoneEvent::Part] The completed summary part.
+        #
+        #   @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::BetaResponseReasoningSummaryPartDoneEvent::Agent, nil] The agent that owns this multi-agent streaming event.
+        #
+        #   @param status [Symbol, OpenAI::Models::Beta::BetaResponseReasoningSummaryPartDoneEvent::Status] The completion status of the summary part. Omitted when the part completed
+        #
+        #   @param type [Symbol, :"response.reasoning_summary_part.done"] The type of the event. Always `response.reasoning_summary_part.done`.
+
+        # @see OpenAI::Models::Beta::BetaResponseReasoningSummaryPartDoneEvent#part
+        class Part < OpenAI::Internal::Type::BaseModel
+          # @!attribute text
+          #   The text of the summary part.
+          #
+          #   @return [String]
+          required :text, String
+
+          # @!attribute type
+          #   The type of the summary part. Always `summary_text`.
+          #
+          #   @return [Symbol, :summary_text]
+          required :type, const: :summary_text
+
+          # @!method initialize(text:, type: :summary_text)
+          #   The completed summary part.
+          #
+          #   @param text [String] The text of the summary part.
+          #
+          #   @param type [Symbol, :summary_text] The type of the summary part. Always `summary_text`.
+        end
+
+        # @see OpenAI::Models::Beta::BetaResponseReasoningSummaryPartDoneEvent#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
+
+        # The completion status of the summary part. Omitted when the part completed
+        # normally and set to `incomplete` when generation was interrupted.
+        #
+        # @see OpenAI::Models::Beta::BetaResponseReasoningSummaryPartDoneEvent#status
+        module Status
+          extend OpenAI::Internal::Type::Enum
+
+          INCOMPLETE = :incomplete
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+
+    BetaResponseReasoningSummaryPartDoneEvent = Beta::BetaResponseReasoningSummaryPartDoneEvent
+  end
+end