openai 0.87.0 → 0.88.0

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

@@ -38,20 +38,25 @@ module OpenAI
         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. For reasoning items, `encrypted_content`
+        #   @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. For reasoning items, `encrypted_content` may be
+        #     incomplete while the item is in progress. Use the reasoning item from the
+        #     corresponding `response.output_item.done` event when passing it as input to a
+        #     subsequent request.
         #
-        #   @param output_index [Integer] The index of 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 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 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`.
+        #   @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
@@ -64,7 +69,8 @@ module OpenAI
           # @!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.
+          #   @param agent_name [String]
+          #     The canonical name of the agent that produced this item.
         end
       end
     end

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

@@ -35,20 +35,22 @@ module OpenAI
         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 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 output_index [Integer]
+        #     The index of the output item that was marked done.
         #
-        #   @param sequence_number [Integer] The sequence number of this event.
+        #   @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 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`.
+        #   @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
@@ -61,7 +63,8 @@ module OpenAI
           # @!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.
+          #   @param agent_name [String]
+          #     The canonical name of the agent that produced this item.
         end
       end
     end

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

@@ -54,24 +54,32 @@ module OpenAI
         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 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 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 status [Symbol, OpenAI::Models::Beta::BetaResponseOutputMessage::Status]
+        #     The status of the message input. One of `in_progress`, `completed`, or
+        #     `incomplete`. Populated when input items are returned via API.
         #
-        #   @param agent [OpenAI::Models::Beta::BetaResponseOutputMessage::Agent, nil] The agent that produced this item.
+        #   @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 phase [Symbol, OpenAI::Models::Beta::BetaResponseOutputMessage::Phase, nil]
+        #     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.
         #
-        #   @param role [Symbol, :assistant] The role of the output message. Always `assistant`.
+        #   @param role [Symbol, :assistant]
+        #     The role of the output message. Always `assistant`.
         #
-        #   @param type [Symbol, :message] The type of the output message. Always `message`.
+        #   @param type [Symbol, :message]
+        #     The type of the output message. Always `message`.
 
         # A text output from the model.
         module Content
@@ -115,7 +123,8 @@ module OpenAI
           # @!method initialize(agent_name:)
           #   The agent that produced this item.
           #
-          #   @param agent_name [String] The canonical name of 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

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

@@ -19,9 +19,11 @@ module OpenAI
         # @!method initialize(refusal:, type: :refusal)
         #   A refusal from the model.
         #
-        #   @param refusal [String] The refusal explanation from the model.
+        #   @param refusal [String]
+        #     The refusal explanation from the model.
         #
-        #   @param type [Symbol, :refusal] The type of the refusal. Always `refusal`.
+        #   @param type [Symbol, :refusal]
+        #     The type of the refusal. Always `refusal`.
       end
     end
 

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

@@ -33,13 +33,16 @@ module OpenAI
         # @!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 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 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`.
+        #   @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
@@ -90,13 +93,17 @@ module OpenAI
             # @!method initialize(file_id:, filename:, index:, type: :file_citation)
             #   A citation to a file.
             #
-            #   @param file_id [String] The ID of the file.
+            #   @param file_id [String]
+            #     The ID of the file.
             #
-            #   @param filename [String] The filename of the file cited.
+            #   @param filename [String]
+            #     The filename of the file cited.
             #
-            #   @param index [Integer] The index of the file in the list of files.
+            #   @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`.
+            #   @param type [Symbol, :file_citation]
+            #     The type of the file citation. Always `file_citation`.
           end
 
           class URLCitation < OpenAI::Internal::Type::BaseModel
@@ -133,15 +140,20 @@ module OpenAI
             # @!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 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 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 title [String]
+            #     The title of the web resource.
             #
-            #   @param url [String] The URL 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`.
+            #   @param type [Symbol, :url_citation]
+            #     The type of the URL citation. Always `url_citation`.
           end
 
           class ContainerFileCitation < OpenAI::Internal::Type::BaseModel
@@ -184,17 +196,23 @@ module OpenAI
             # @!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 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 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 file_id [String]
+            #     The ID of the file.
             #
-            #   @param filename [String] The filename of the container file cited.
+            #   @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 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`.
+            #   @param type [Symbol, :container_file_citation]
+            #     The type of the container file citation. Always `container_file_citation`.
           end
 
           class FilePath < OpenAI::Internal::Type::BaseModel
@@ -217,17 +235,16 @@ module OpenAI
             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 file_id [String]
+            #     The ID of the file.
             #
-            #   @param index [Integer] The index of the file in the list of files.
+            #   @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`.
+            #   @param type [Symbol, :file_path]
+            #     The type of the file path. Always `file_path`.
           end
 
           # @!method self.variants

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

@@ -59,21 +59,29 @@ module OpenAI
         # @!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 [OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent::Annotation::FileCitation, OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent::Annotation::URLCitation, OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent::Annotation::ContainerFileCitation, OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent::Annotation::FilePath, nil] An annotation that applies to a span of output text.
+        #   @param annotation [OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent::Annotation::FileCitation, OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent::Annotation::URLCitation, OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent::Annotation::ContainerFileCitation, OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent::Annotation::FilePath, nil]
+        #     An annotation that applies to a span of output text.
         #
-        #   @param annotation_index [Integer] The index of the annotation within the content part.
+        #   @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 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 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 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 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 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'.
+        #   @param type [Symbol, :"response.output_text.annotation.added"]
+        #     The type of the event. Always 'response.output_text.annotation.added'.
 
         # An annotation that applies to a span of output text.
         #
@@ -132,13 +140,17 @@ module OpenAI
             # @!method initialize(file_id:, filename:, index:, type: :file_citation)
             #   A citation to a file.
             #
-            #   @param file_id [String] The ID of the file.
+            #   @param file_id [String]
+            #     The ID of the file.
             #
-            #   @param filename [String] The filename of the file cited.
+            #   @param filename [String]
+            #     The filename of the file cited.
             #
-            #   @param index [Integer] The index of the file in the list of files.
+            #   @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`.
+            #   @param type [Symbol, :file_citation]
+            #     The type of the file citation. Always `file_citation`.
           end
 
           class URLCitation < OpenAI::Internal::Type::BaseModel
@@ -175,15 +187,20 @@ module OpenAI
             # @!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 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 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 title [String]
+            #     The title of the web resource.
             #
-            #   @param url [String] The URL 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`.
+            #   @param type [Symbol, :url_citation]
+            #     The type of the URL citation. Always `url_citation`.
           end
 
           class ContainerFileCitation < OpenAI::Internal::Type::BaseModel
@@ -226,17 +243,23 @@ module OpenAI
             # @!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 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 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 file_id [String]
+            #     The ID of the file.
             #
-            #   @param filename [String] The filename of the container file cited.
+            #   @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 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`.
+            #   @param type [Symbol, :container_file_citation]
+            #     The type of the container file citation. Always `container_file_citation`.
           end
 
           class FilePath < OpenAI::Internal::Type::BaseModel
@@ -259,17 +282,16 @@ module OpenAI
             required :type, const: :file_path
 
             # @!method initialize(file_id:, index:, type: :file_path)
-            #   Some parameter documentations has been truncated, see
-            #   {OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent::Annotation::FilePath}
-            #   for more details.
-            #
             #   A path to a file.
             #
-            #   @param file_id [String] The ID of the file.
+            #   @param file_id [String]
+            #     The ID of the file.
             #
-            #   @param index [Integer] The index of the file in the list of files.
+            #   @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`.
+            #   @param type [Symbol, :file_path]
+            #     The type of the file path. Always `file_path`.
           end
 
           # @!method self.variants
@@ -287,7 +309,8 @@ module OpenAI
           # @!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.
+          #   @param agent_name [String]
+          #     The canonical name of the agent that produced this item.
         end
       end
     end

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

@@ -29,17 +29,19 @@ module OpenAI
         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).
+        #   [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
         #
-        #   @param id [String] The unique identifier of the prompt template to use.
+        #   @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 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 prompt. The
+        #     substitution values can either be strings, or other Response input types like
+        #     images or files.
         #
-        #   @param version [String, nil] Optional version of the prompt template.
+        #   @param version [String, nil]
+        #     Optional version of the prompt template.
 
         # A text input to the model.
         module Variable
@@ -50,7 +52,7 @@ module OpenAI
           # 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).
+          # An image input to the model. Learn about [image inputs](https://developers.openai.com/api/docs/guides/images-vision).
           variant -> { OpenAI::Beta::BetaResponseInputImage }
 
           # A file input to the model.

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

@@ -31,13 +31,17 @@ module OpenAI
         # @!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 response [OpenAI::Models::Beta::BetaResponse]
+        #     The full response object that is queued.
         #
-        #   @param sequence_number [Integer] The sequence number for this event.
+        #   @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 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'.
+        #   @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
@@ -50,7 +54,8 @@ module OpenAI
           # @!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.
+          #   @param agent_name [String]
+          #     The canonical name of the agent that produced this item.
         end
       end
     end

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

@@ -61,28 +61,39 @@ module OpenAI
         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).
+        #   [managing context](https://developers.openai.com/api/docs/guides/conversation-state).
         #
-        #   @param id [String] The unique identifier of the reasoning content.
+        #   @param id [String]
+        #     The unique identifier of the reasoning content.
         #
-        #   @param summary [Array<OpenAI::Models::Beta::BetaResponseReasoningItem::Summary>] Reasoning summary 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 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 content [Array<OpenAI::Models::Beta::BetaResponseReasoningItem::Content>]
+        #     Reasoning text content.
         #
-        #   @param encrypted_content [String, nil] The encrypted content of the reasoning item. This is populated by default
+        #   @param encrypted_content [String, nil]
+        #     The encrypted content of the reasoning item. This is populated by default for
+        #     reasoning items returned by `POST /v1/responses` and WebSocket `response.create`
+        #     requests.
         #
-        #   @param status [Symbol, OpenAI::Models::Beta::BetaResponseReasoningItem::Status] The status of the item. One of `in_progress`, `completed`, or
+        #     When streaming, use the completed reasoning item and its `encrypted_content`
+        #     from the `response.output_item.done` event in subsequent requests. The
+        #     `encrypted_content` in `response.output_item.added` may be incomplete. This is
+        #     especially important when `store` is `false` or when using Zero Data Retention.
         #
-        #   @param type [Symbol, :reasoning] The type of the object. Always `reasoning`.
-
+        #   @param status [Symbol, OpenAI::Models::Beta::BetaResponseReasoningItem::Status]
+        #     The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+        #     Populated when items are returned via API.
+        #
+        #   @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.
@@ -99,9 +110,11 @@ module OpenAI
           # @!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 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`.
+          #   @param type [Symbol, :summary_text]
+          #     The type of the object. Always `summary_text`.
         end
 
         # @see OpenAI::Models::Beta::BetaResponseReasoningItem#agent
@@ -115,7 +128,8 @@ module OpenAI
           # @!method initialize(agent_name:)
           #   The agent that produced this item.
           #
-          #   @param agent_name [String] The canonical name of 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
@@ -134,9 +148,11 @@ module OpenAI
           # @!method initialize(text:, type: :reasoning_text)
           #   Reasoning text from the model.
           #
-          #   @param text [String] The 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`.
+          #   @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`.