openai 0.67.0 → 0.69.0

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

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseOutputItemAddedEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute item
+        #   The output item that was added.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseFunctionToolCall, OpenAI::Models::Beta::BetaResponseFunctionToolCallOutputItem, OpenAI::Models::Beta::BetaResponseOutputItem::AgentMessage, OpenAI::Models::Beta::BetaResponseOutputItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseOutputItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCallOutputItem, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseOutputItem::Program, OpenAI::Models::Beta::BetaResponseOutputItem::ProgramOutput, OpenAI::Models::Beta::BetaResponseToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItem, OpenAI::Models::Beta::BetaResponseOutputItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseCompactionItem, OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseFunctionShellToolCall, OpenAI::Models::Beta::BetaResponseFunctionShellToolCallOutput, OpenAI::Models::Beta::BetaResponseApplyPatchToolCall, OpenAI::Models::Beta::BetaResponseApplyPatchToolCallOutput, OpenAI::Models::Beta::BetaResponseOutputItem::McpCall, OpenAI::Models::Beta::BetaResponseOutputItem::McpListTools, OpenAI::Models::Beta::BetaResponseOutputItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseOutputItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseCustomToolCall, OpenAI::Models::Beta::BetaResponseCustomToolCallOutputItem]
+        required :item, union: -> { OpenAI::Beta::BetaResponseOutputItem }
+
+        # @!attribute output_index
+        #   The index of the output item that was added.
+        #
+        #   @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_item.added`.
+        #
+        #   @return [Symbol, :"response.output_item.added"]
+        required :type, const: :"response.output_item.added"
+
+        # @!attribute agent
+        #   The agent that owns this multi-agent streaming event.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseOutputItemAddedEvent::Agent, nil]
+        optional :agent, -> { OpenAI::Beta::BetaResponseOutputItemAddedEvent::Agent }, nil?: true
+
+        # @!method initialize(item:, output_index:, sequence_number:, agent: nil, type: :"response.output_item.added")
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Beta::BetaResponseOutputItemAddedEvent} for more details.
+        #
+        #   Emitted when a new output item is added.
+        #
+        #   @param item [OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseFunctionToolCall, OpenAI::Models::Beta::BetaResponseFunctionToolCallOutputItem, OpenAI::Models::Beta::BetaResponseOutputItem::AgentMessage, OpenAI::Models::Beta::BetaResponseOutputItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseOutputItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCallOutputItem, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseOutputItem::Program, OpenAI::Models::Beta::BetaResponseOutputItem::ProgramOutput, OpenAI::Models::Beta::BetaResponseToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItem, OpenAI::Models::Beta::BetaResponseOutputItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseCompactionItem, OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseFunctionShellToolCall, OpenAI::Models::Beta::BetaResponseFunctionShellToolCallOutput, OpenAI::Models::Beta::BetaResponseApplyPatchToolCall, OpenAI::Models::Beta::BetaResponseApplyPatchToolCallOutput, OpenAI::Models::Beta::BetaResponseOutputItem::McpCall, OpenAI::Models::Beta::BetaResponseOutputItem::McpListTools, OpenAI::Models::Beta::BetaResponseOutputItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseOutputItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseCustomToolCall, OpenAI::Models::Beta::BetaResponseCustomToolCallOutputItem] The output item that was added.
+        #
+        #   @param output_index [Integer] The index of the output item that was added.
+        #
+        #   @param sequence_number [Integer] The sequence number of this event.
+        #
+        #   @param agent [OpenAI::Models::Beta::BetaResponseOutputItemAddedEvent::Agent, nil] The agent that owns this multi-agent streaming event.
+        #
+        #   @param type [Symbol, :"response.output_item.added"] The type of the event. Always `response.output_item.added`.
+
+        # @see OpenAI::Models::Beta::BetaResponseOutputItemAddedEvent#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
+
+    BetaResponseOutputItemAddedEvent = Beta::BetaResponseOutputItemAddedEvent
+  end
+end

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

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseOutputItemDoneEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute item
+        #   The output item that was marked done.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseFunctionToolCall, OpenAI::Models::Beta::BetaResponseFunctionToolCallOutputItem, OpenAI::Models::Beta::BetaResponseOutputItem::AgentMessage, OpenAI::Models::Beta::BetaResponseOutputItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseOutputItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCallOutputItem, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseOutputItem::Program, OpenAI::Models::Beta::BetaResponseOutputItem::ProgramOutput, OpenAI::Models::Beta::BetaResponseToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItem, OpenAI::Models::Beta::BetaResponseOutputItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseCompactionItem, OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseFunctionShellToolCall, OpenAI::Models::Beta::BetaResponseFunctionShellToolCallOutput, OpenAI::Models::Beta::BetaResponseApplyPatchToolCall, OpenAI::Models::Beta::BetaResponseApplyPatchToolCallOutput, OpenAI::Models::Beta::BetaResponseOutputItem::McpCall, OpenAI::Models::Beta::BetaResponseOutputItem::McpListTools, OpenAI::Models::Beta::BetaResponseOutputItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseOutputItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseCustomToolCall, OpenAI::Models::Beta::BetaResponseCustomToolCallOutputItem]
+        required :item, union: -> { OpenAI::Beta::BetaResponseOutputItem }
+
+        # @!attribute output_index
+        #   The index of the output item that was marked done.
+        #
+        #   @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_item.done`.
+        #
+        #   @return [Symbol, :"response.output_item.done"]
+        required :type, const: :"response.output_item.done"
+
+        # @!attribute agent
+        #   The agent that owns this multi-agent streaming event.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseOutputItemDoneEvent::Agent, nil]
+        optional :agent, -> { OpenAI::Beta::BetaResponseOutputItemDoneEvent::Agent }, nil?: true
+
+        # @!method initialize(item:, output_index:, sequence_number:, agent: nil, type: :"response.output_item.done")
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Beta::BetaResponseOutputItemDoneEvent} for more details.
+        #
+        #   Emitted when an output item is marked done.
+        #
+        #   @param item [OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseFunctionToolCall, OpenAI::Models::Beta::BetaResponseFunctionToolCallOutputItem, OpenAI::Models::Beta::BetaResponseOutputItem::AgentMessage, OpenAI::Models::Beta::BetaResponseOutputItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseOutputItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCallOutputItem, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseOutputItem::Program, OpenAI::Models::Beta::BetaResponseOutputItem::ProgramOutput, OpenAI::Models::Beta::BetaResponseToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItem, OpenAI::Models::Beta::BetaResponseOutputItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseCompactionItem, OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseFunctionShellToolCall, OpenAI::Models::Beta::BetaResponseFunctionShellToolCallOutput, OpenAI::Models::Beta::BetaResponseApplyPatchToolCall, OpenAI::Models::Beta::BetaResponseApplyPatchToolCallOutput, OpenAI::Models::Beta::BetaResponseOutputItem::McpCall, OpenAI::Models::Beta::BetaResponseOutputItem::McpListTools, OpenAI::Models::Beta::BetaResponseOutputItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseOutputItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseCustomToolCall, OpenAI::Models::Beta::BetaResponseCustomToolCallOutputItem] The output item that was marked done.
+        #
+        #   @param output_index [Integer] The index of the output item that was marked done.
+        #
+        #   @param sequence_number [Integer] The sequence number of this event.
+        #
+        #   @param agent [OpenAI::Models::Beta::BetaResponseOutputItemDoneEvent::Agent, nil] The agent that owns this multi-agent streaming event.
+        #
+        #   @param type [Symbol, :"response.output_item.done"] The type of the event. Always `response.output_item.done`.
+
+        # @see OpenAI::Models::Beta::BetaResponseOutputItemDoneEvent#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
+
+    BetaResponseOutputItemDoneEvent = Beta::BetaResponseOutputItemDoneEvent
+  end
+end

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

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseOutputMessage < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique ID of the output message.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute content
+        #   The content of the output message.
+        #
+        #   @return [Array<OpenAI::Models::Beta::BetaResponseOutputText, OpenAI::Models::Beta::BetaResponseOutputRefusal>]
+        required :content,
+                 -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::BetaResponseOutputMessage::Content] }
+
+        # @!attribute role
+        #   The role of the output message. Always `assistant`.
+        #
+        #   @return [Symbol, :assistant]
+        required :role, const: :assistant
+
+        # @!attribute status
+        #   The status of the message input. One of `in_progress`, `completed`, or
+        #   `incomplete`. Populated when input items are returned via API.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::BetaResponseOutputMessage::Status]
+        required :status, enum: -> { OpenAI::Beta::BetaResponseOutputMessage::Status }
+
+        # @!attribute type
+        #   The type of the output message. Always `message`.
+        #
+        #   @return [Symbol, :message]
+        required :type, const: :message
+
+        # @!attribute agent
+        #   The agent that produced this item.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseOutputMessage::Agent, nil]
+        optional :agent, -> { OpenAI::Beta::BetaResponseOutputMessage::Agent }, nil?: true
+
+        # @!attribute phase
+        #   Labels an `assistant` message as intermediate commentary (`commentary`) or the
+        #   final answer (`final_answer`). For models like `gpt-5.3-codex` and beyond, when
+        #   sending follow-up requests, preserve and resend phase on all assistant messages
+        #   — dropping it can degrade performance. Not used for user messages.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::BetaResponseOutputMessage::Phase, nil]
+        optional :phase, enum: -> { OpenAI::Beta::BetaResponseOutputMessage::Phase }, nil?: true
+
+        # @!method initialize(id:, content:, status:, agent: nil, phase: nil, role: :assistant, type: :message)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Beta::BetaResponseOutputMessage} for more details.
+        #
+        #   An output message from the model.
+        #
+        #   @param id [String] The unique ID of the output message.
+        #
+        #   @param content [Array<OpenAI::Models::Beta::BetaResponseOutputText, OpenAI::Models::Beta::BetaResponseOutputRefusal>] The content of the output message.
+        #
+        #   @param status [Symbol, OpenAI::Models::Beta::BetaResponseOutputMessage::Status] The status of the message input. One of `in_progress`, `completed`, or
+        #
+        #   @param agent [OpenAI::Models::Beta::BetaResponseOutputMessage::Agent, nil] The agent that produced this item.
+        #
+        #   @param phase [Symbol, OpenAI::Models::Beta::BetaResponseOutputMessage::Phase, nil] Labels an `assistant` message as intermediate commentary (`commentary`) or the f
+        #
+        #   @param role [Symbol, :assistant] The role of the output message. Always `assistant`.
+        #
+        #   @param type [Symbol, :message] The type of the output message. Always `message`.
+
+        # A text output from the model.
+        module Content
+          extend OpenAI::Internal::Type::Union
+
+          discriminator :type
+
+          # A text output from the model.
+          variant :output_text, -> { OpenAI::Beta::BetaResponseOutputText }
+
+          # A refusal from the model.
+          variant :refusal, -> { OpenAI::Beta::BetaResponseOutputRefusal }
+
+          # @!method self.variants
+          #   @return [Array(OpenAI::Models::Beta::BetaResponseOutputText, OpenAI::Models::Beta::BetaResponseOutputRefusal)]
+        end
+
+        # The status of the message input. One of `in_progress`, `completed`, or
+        # `incomplete`. Populated when input items are returned via API.
+        #
+        # @see OpenAI::Models::Beta::BetaResponseOutputMessage#status
+        module Status
+          extend OpenAI::Internal::Type::Enum
+
+          IN_PROGRESS = :in_progress
+          COMPLETED = :completed
+          INCOMPLETE = :incomplete
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see OpenAI::Models::Beta::BetaResponseOutputMessage#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
+
+        # Labels an `assistant` message as intermediate commentary (`commentary`) or the
+        # final answer (`final_answer`). For models like `gpt-5.3-codex` and beyond, when
+        # sending follow-up requests, preserve and resend phase on all assistant messages
+        # — dropping it can degrade performance. Not used for user messages.
+        #
+        # @see OpenAI::Models::Beta::BetaResponseOutputMessage#phase
+        module Phase
+          extend OpenAI::Internal::Type::Enum
+
+          COMMENTARY = :commentary
+          FINAL_ANSWER = :final_answer
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+
+    BetaResponseOutputMessage = Beta::BetaResponseOutputMessage
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseOutputRefusal < OpenAI::Internal::Type::BaseModel
+        # @!attribute refusal
+        #   The refusal explanation from the model.
+        #
+        #   @return [String]
+        required :refusal, String
+
+        # @!attribute type
+        #   The type of the refusal. Always `refusal`.
+        #
+        #   @return [Symbol, :refusal]
+        required :type, const: :refusal
+
+        # @!method initialize(refusal:, type: :refusal)
+        #   A refusal from the model.
+        #
+        #   @param refusal [String] The refusal explanation from the model.
+        #
+        #   @param type [Symbol, :refusal] The type of the refusal. Always `refusal`.
+      end
+    end
+
+    BetaResponseOutputRefusal = Beta::BetaResponseOutputRefusal
+  end
+end

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

@@ -0,0 +1,292 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseOutputText < OpenAI::Internal::Type::BaseModel
+        # @!attribute annotations
+        #   The annotations of the text output.
+        #
+        #   @return [Array<OpenAI::Models::Beta::BetaResponseOutputText::Annotation::FileCitation, OpenAI::Models::Beta::BetaResponseOutputText::Annotation::URLCitation, OpenAI::Models::Beta::BetaResponseOutputText::Annotation::ContainerFileCitation, OpenAI::Models::Beta::BetaResponseOutputText::Annotation::FilePath>]
+        required :annotations,
+                 -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::BetaResponseOutputText::Annotation] }
+
+        # @!attribute text
+        #   The text output from the model.
+        #
+        #   @return [String]
+        required :text, String
+
+        # @!attribute type
+        #   The type of the output text. Always `output_text`.
+        #
+        #   @return [Symbol, :output_text]
+        required :type, const: :output_text
+
+        # @!attribute logprobs
+        #
+        #   @return [Array<OpenAI::Models::Beta::BetaResponseOutputText::Logprob>, nil]
+        optional :logprobs, -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Beta::BetaResponseOutputText::Logprob] }
+
+        # @!method initialize(annotations:, text:, logprobs: nil, type: :output_text)
+        #   A text output from the model.
+        #
+        #   @param annotations [Array<OpenAI::Models::Beta::BetaResponseOutputText::Annotation::FileCitation, OpenAI::Models::Beta::BetaResponseOutputText::Annotation::URLCitation, OpenAI::Models::Beta::BetaResponseOutputText::Annotation::ContainerFileCitation, OpenAI::Models::Beta::BetaResponseOutputText::Annotation::FilePath>] The annotations of the text output.
+        #
+        #   @param text [String] The text output from the model.
+        #
+        #   @param logprobs [Array<OpenAI::Models::Beta::BetaResponseOutputText::Logprob>]
+        #
+        #   @param type [Symbol, :output_text] The type of the output text. Always `output_text`.
+
+        # An annotation that applies to a span of output text.
+        module Annotation
+          extend OpenAI::Internal::Type::Union
+
+          discriminator :type
+
+          # A citation to a file.
+          variant :file_citation, -> { OpenAI::Beta::BetaResponseOutputText::Annotation::FileCitation }
+
+          # A citation for a web resource used to generate a model response.
+          variant :url_citation, -> { OpenAI::Beta::BetaResponseOutputText::Annotation::URLCitation }
+
+          # A citation for a container file used to generate a model response.
+          variant :container_file_citation,
+                  -> { OpenAI::Beta::BetaResponseOutputText::Annotation::ContainerFileCitation }
+
+          # A path to a file.
+          variant :file_path, -> { OpenAI::Beta::BetaResponseOutputText::Annotation::FilePath }
+
+          class FileCitation < OpenAI::Internal::Type::BaseModel
+            # @!attribute file_id
+            #   The ID of the file.
+            #
+            #   @return [String]
+            required :file_id, String
+
+            # @!attribute filename
+            #   The filename of the file cited.
+            #
+            #   @return [String]
+            required :filename, String
+
+            # @!attribute index
+            #   The index of the file in the list of files.
+            #
+            #   @return [Integer]
+            required :index, Integer
+
+            # @!attribute type
+            #   The type of the file citation. Always `file_citation`.
+            #
+            #   @return [Symbol, :file_citation]
+            required :type, const: :file_citation
+
+            # @!method initialize(file_id:, filename:, index:, type: :file_citation)
+            #   A citation to a file.
+            #
+            #   @param file_id [String] The ID of the file.
+            #
+            #   @param filename [String] The filename of the file cited.
+            #
+            #   @param index [Integer] The index of the file in the list of files.
+            #
+            #   @param type [Symbol, :file_citation] The type of the file citation. Always `file_citation`.
+          end
+
+          class URLCitation < OpenAI::Internal::Type::BaseModel
+            # @!attribute end_index
+            #   The index of the last character of the URL citation in the message.
+            #
+            #   @return [Integer]
+            required :end_index, Integer
+
+            # @!attribute start_index
+            #   The index of the first character of the URL citation in the message.
+            #
+            #   @return [Integer]
+            required :start_index, Integer
+
+            # @!attribute title
+            #   The title of the web resource.
+            #
+            #   @return [String]
+            required :title, String
+
+            # @!attribute type
+            #   The type of the URL citation. Always `url_citation`.
+            #
+            #   @return [Symbol, :url_citation]
+            required :type, const: :url_citation
+
+            # @!attribute url
+            #   The URL of the web resource.
+            #
+            #   @return [String]
+            required :url, String
+
+            # @!method initialize(end_index:, start_index:, title:, url:, type: :url_citation)
+            #   A citation for a web resource used to generate a model response.
+            #
+            #   @param end_index [Integer] The index of the last character of the URL citation in the message.
+            #
+            #   @param start_index [Integer] The index of the first character of the URL citation in the message.
+            #
+            #   @param title [String] The title of the web resource.
+            #
+            #   @param url [String] The URL of the web resource.
+            #
+            #   @param type [Symbol, :url_citation] The type of the URL citation. Always `url_citation`.
+          end
+
+          class ContainerFileCitation < OpenAI::Internal::Type::BaseModel
+            # @!attribute container_id
+            #   The ID of the container file.
+            #
+            #   @return [String]
+            required :container_id, String
+
+            # @!attribute end_index
+            #   The index of the last character of the container file citation in the message.
+            #
+            #   @return [Integer]
+            required :end_index, Integer
+
+            # @!attribute file_id
+            #   The ID of the file.
+            #
+            #   @return [String]
+            required :file_id, String
+
+            # @!attribute filename
+            #   The filename of the container file cited.
+            #
+            #   @return [String]
+            required :filename, String
+
+            # @!attribute start_index
+            #   The index of the first character of the container file citation in the message.
+            #
+            #   @return [Integer]
+            required :start_index, Integer
+
+            # @!attribute type
+            #   The type of the container file citation. Always `container_file_citation`.
+            #
+            #   @return [Symbol, :container_file_citation]
+            required :type, const: :container_file_citation
+
+            # @!method initialize(container_id:, end_index:, file_id:, filename:, start_index:, type: :container_file_citation)
+            #   A citation for a container file used to generate a model response.
+            #
+            #   @param container_id [String] The ID of the container file.
+            #
+            #   @param end_index [Integer] The index of the last character of the container file citation in the message.
+            #
+            #   @param file_id [String] The ID of the file.
+            #
+            #   @param filename [String] The filename of the container file cited.
+            #
+            #   @param start_index [Integer] The index of the first character of the container file citation in the message.
+            #
+            #   @param type [Symbol, :container_file_citation] The type of the container file citation. Always `container_file_citation`.
+          end
+
+          class FilePath < OpenAI::Internal::Type::BaseModel
+            # @!attribute file_id
+            #   The ID of the file.
+            #
+            #   @return [String]
+            required :file_id, String
+
+            # @!attribute index
+            #   The index of the file in the list of files.
+            #
+            #   @return [Integer]
+            required :index, Integer
+
+            # @!attribute type
+            #   The type of the file path. Always `file_path`.
+            #
+            #   @return [Symbol, :file_path]
+            required :type, const: :file_path
+
+            # @!method initialize(file_id:, index:, type: :file_path)
+            #   Some parameter documentations has been truncated, see
+            #   {OpenAI::Models::Beta::BetaResponseOutputText::Annotation::FilePath} for more
+            #   details.
+            #
+            #   A path to a file.
+            #
+            #   @param file_id [String] The ID of the file.
+            #
+            #   @param index [Integer] The index of the file in the list of files.
+            #
+            #   @param type [Symbol, :file_path] The type of the file path. Always `file_path`.
+          end
+
+          # @!method self.variants
+          #   @return [Array(OpenAI::Models::Beta::BetaResponseOutputText::Annotation::FileCitation, OpenAI::Models::Beta::BetaResponseOutputText::Annotation::URLCitation, OpenAI::Models::Beta::BetaResponseOutputText::Annotation::ContainerFileCitation, OpenAI::Models::Beta::BetaResponseOutputText::Annotation::FilePath)]
+        end
+
+        class Logprob < OpenAI::Internal::Type::BaseModel
+          # @!attribute token
+          #
+          #   @return [String]
+          required :token, String
+
+          # @!attribute bytes
+          #
+          #   @return [Array<Integer>]
+          required :bytes, OpenAI::Internal::Type::ArrayOf[Integer]
+
+          # @!attribute logprob
+          #
+          #   @return [Float]
+          required :logprob, Float
+
+          # @!attribute top_logprobs
+          #
+          #   @return [Array<OpenAI::Models::Beta::BetaResponseOutputText::Logprob::TopLogprob>]
+          required :top_logprobs,
+                   -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Beta::BetaResponseOutputText::Logprob::TopLogprob] }
+
+          # @!method initialize(token:, bytes:, logprob:, top_logprobs:)
+          #   The log probability of a token.
+          #
+          #   @param token [String]
+          #   @param bytes [Array<Integer>]
+          #   @param logprob [Float]
+          #   @param top_logprobs [Array<OpenAI::Models::Beta::BetaResponseOutputText::Logprob::TopLogprob>]
+
+          class TopLogprob < OpenAI::Internal::Type::BaseModel
+            # @!attribute token
+            #
+            #   @return [String]
+            required :token, String
+
+            # @!attribute bytes
+            #
+            #   @return [Array<Integer>]
+            required :bytes, OpenAI::Internal::Type::ArrayOf[Integer]
+
+            # @!attribute logprob
+            #
+            #   @return [Float]
+            required :logprob, Float
+
+            # @!method initialize(token:, bytes:, logprob:)
+            #   The top log probability of a token.
+            #
+            #   @param token [String]
+            #   @param bytes [Array<Integer>]
+            #   @param logprob [Float]
+          end
+        end
+      end
+    end
+
+    BetaResponseOutputText = Beta::BetaResponseOutputText
+  end
+end