openai 0.91.0 → 0.93.0

data/sig/openai/models/beta/beta_response_output_item_added_event.rbs

@@ -13,16 +13,37 @@ module OpenAI
         }
 
       class BetaResponseOutputItemAddedEvent < OpenAI::Internal::Type::BaseModel
+        # 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.
         attr_accessor item: OpenAI::Models::Beta::beta_response_output_item
 
+        # The index of the output item that was added.
         attr_accessor output_index: Integer
 
+        # The sequence number of this event.
         attr_accessor sequence_number: Integer
 
+        # The type of the event. Always `response.output_item.added`.
         attr_accessor type: :"response.output_item.added"
 
+        # The agent that owns this multi-agent streaming event.
         attr_accessor agent: OpenAI::Beta::BetaResponseOutputItemAddedEvent::Agent?
 
+        # @param item
+        #   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
+        #   The index of the output item that was added.
+        # @param sequence_number
+        #   The sequence number of this event.
+        # @param agent
+        #   The agent that owns this multi-agent streaming event.
+        # @param type
+        #   The type of the event. Always `response.output_item.added`.
         def initialize: (
           item: OpenAI::Models::Beta::beta_response_output_item,
           output_index: Integer,
@@ -42,8 +63,11 @@ module OpenAI
         type agent = { agent_name: String }
 
         class Agent < OpenAI::Internal::Type::BaseModel
+          # The canonical name of the agent that produced this item.
           attr_accessor agent_name: String
 
+          # @param agent_name
+          #   The canonical name of the agent that produced this item.
           def initialize: (agent_name: String) -> void
 
           def to_hash: -> { agent_name: String }

data/sig/openai/models/beta/beta_response_output_item_done_event.rbs

@@ -13,16 +13,31 @@ module OpenAI
         }
 
       class BetaResponseOutputItemDoneEvent < OpenAI::Internal::Type::BaseModel
+        # The output item that was marked done.
         attr_accessor item: OpenAI::Models::Beta::beta_response_output_item
 
+        # The index of the output item that was marked done.
         attr_accessor output_index: Integer
 
+        # The sequence number of this event.
         attr_accessor sequence_number: Integer
 
+        # The type of the event. Always `response.output_item.done`.
         attr_accessor type: :"response.output_item.done"
 
+        # The agent that owns this multi-agent streaming event.
         attr_accessor agent: OpenAI::Beta::BetaResponseOutputItemDoneEvent::Agent?
 
+        # @param item
+        #   The output item that was marked done.
+        # @param output_index
+        #   The index of the output item that was marked done.
+        # @param sequence_number
+        #   The sequence number of this event.
+        # @param agent
+        #   The agent that owns this multi-agent streaming event.
+        # @param type
+        #   The type of the event. Always `response.output_item.done`.
         def initialize: (
           item: OpenAI::Models::Beta::beta_response_output_item,
           output_index: Integer,
@@ -42,8 +57,11 @@ module OpenAI
         type agent = { agent_name: String }
 
         class Agent < OpenAI::Internal::Type::BaseModel
+          # The canonical name of the agent that produced this item.
           attr_accessor agent_name: String
 
+          # @param agent_name
+          #   The canonical name of the agent that produced this item.
           def initialize: (agent_name: String) -> void
 
           def to_hash: -> { agent_name: String }

data/sig/openai/models/beta/beta_response_output_message.rbs

@@ -15,20 +15,49 @@ module OpenAI
         }
 
       class BetaResponseOutputMessage < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the output message.
         attr_accessor id: String
 
+        # The content of the output message.
         attr_accessor content: ::Array[OpenAI::Models::Beta::BetaResponseOutputMessage::content]
 
+        # The role of the output message. Always `assistant`.
         attr_accessor role: :assistant
 
+        # The status of the message input. One of `in_progress`, `completed`, or
+        # `incomplete`. Populated when input items are returned via API.
         attr_accessor status: OpenAI::Models::Beta::BetaResponseOutputMessage::status
 
+        # The type of the output message. Always `message`.
         attr_accessor type: :message
 
+        # The agent that produced this item.
         attr_accessor agent: OpenAI::Beta::BetaResponseOutputMessage::Agent?
 
+        # 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.
         attr_accessor phase: OpenAI::Models::Beta::BetaResponseOutputMessage::phase?
 
+        # @param id
+        #   The unique ID of the output message.
+        # @param content
+        #   The content of the output message.
+        # @param status
+        #   The status of the message input. One of `in_progress`, `completed`, or
+        #   `incomplete`. Populated when input items are returned via API.
+        # @param agent
+        #   The agent that produced this item.
+        # @param 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.
+        # @param role
+        #   The role of the output message. Always `assistant`.
+        # @param type
+        #   The type of the output message. Always `message`.
         def initialize: (
           id: String,
           content: ::Array[OpenAI::Models::Beta::BetaResponseOutputMessage::content],
@@ -74,8 +103,11 @@ module OpenAI
         type agent = { agent_name: String }
 
         class Agent < OpenAI::Internal::Type::BaseModel
+          # The canonical name of the agent that produced this item.
           attr_accessor agent_name: String
 
+          # @param agent_name
+          #   The canonical name of the agent that produced this item.
           def initialize: (agent_name: String) -> void
 
           def to_hash: -> { agent_name: String }

data/sig/openai/models/beta/beta_response_output_refusal.rbs

@@ -6,10 +6,16 @@ module OpenAI
       type beta_response_output_refusal = { refusal: String, ?type: :refusal }
 
       class BetaResponseOutputRefusal < OpenAI::Internal::Type::BaseModel
+        # The refusal explanation from the model.
         attr_accessor refusal: String
 
+        # The type of the refusal. Always `refusal`.
         attr_accessor type: :refusal
 
+        # @param refusal
+        #   The refusal explanation from the model.
+        # @param type
+        #   The type of the refusal. Always `refusal`.
         def initialize: (refusal: String, ?type: :refusal) -> void
 
         def to_hash: -> { refusal: String, ?type: :refusal }

data/sig/openai/models/beta/beta_response_output_text.rbs

@@ -12,10 +12,13 @@ module OpenAI
         }
 
       class BetaResponseOutputText < OpenAI::Internal::Type::BaseModel
+        # The annotations of the text output.
         attr_accessor annotations: ::Array[OpenAI::Models::Beta::BetaResponseOutputText::annotation]
 
+        # The text output from the model.
         attr_accessor text: String
 
+        # The type of the output text. Always `output_text`.
         attr_accessor type: :output_text
 
         attr_reader logprobs: ::Array[OpenAI::Beta::BetaResponseOutputText::Logprob]?
@@ -24,6 +27,12 @@ module OpenAI
           ::Array[OpenAI::Beta::BetaResponseOutputText::Logprob]
         ) -> ::Array[OpenAI::Beta::BetaResponseOutputText::Logprob]
 
+        # @param annotations
+        #   The annotations of the text output.
+        # @param text
+        #   The text output from the model.
+        # @param type
+        #   The type of the output text. Always `output_text`.
         def initialize: (
           annotations: ::Array[OpenAI::Models::Beta::BetaResponseOutputText::annotation],
           text: String,
@@ -56,14 +65,26 @@ module OpenAI
             }
 
           class FileCitation < OpenAI::Internal::Type::BaseModel
+            # The ID of the file.
             attr_accessor file_id: String
 
+            # The filename of the file cited.
             attr_accessor filename: String
 
+            # The index of the file in the list of files.
             attr_accessor index: Integer
 
+            # The type of the file citation. Always `file_citation`.
             attr_accessor type: :file_citation
 
+            # @param file_id
+            #   The ID of the file.
+            # @param filename
+            #   The filename of the file cited.
+            # @param index
+            #   The index of the file in the list of files.
+            # @param type
+            #   The type of the file citation. Always `file_citation`.
             def initialize: (
               file_id: String,
               filename: String,
@@ -89,16 +110,31 @@ module OpenAI
             }
 
           class URLCitation < OpenAI::Internal::Type::BaseModel
+            # The index of the last character of the URL citation in the message.
             attr_accessor end_index: Integer
 
+            # The index of the first character of the URL citation in the message.
             attr_accessor start_index: Integer
 
+            # The title of the web resource.
             attr_accessor title: String
 
+            # The type of the URL citation. Always `url_citation`.
             attr_accessor type: :url_citation
 
+            # The URL of the web resource.
             attr_accessor url: String
 
+            # @param end_index
+            #   The index of the last character of the URL citation in the message.
+            # @param start_index
+            #   The index of the first character of the URL citation in the message.
+            # @param title
+            #   The title of the web resource.
+            # @param url
+            #   The URL of the web resource.
+            # @param type
+            #   The type of the URL citation. Always `url_citation`.
             def initialize: (
               end_index: Integer,
               start_index: Integer,
@@ -127,18 +163,36 @@ module OpenAI
             }
 
           class ContainerFileCitation < OpenAI::Internal::Type::BaseModel
+            # The ID of the container file.
             attr_accessor container_id: String
 
+            # The index of the last character of the container file citation in the message.
             attr_accessor end_index: Integer
 
+            # The ID of the file.
             attr_accessor file_id: String
 
+            # The filename of the container file cited.
             attr_accessor filename: String
 
+            # The index of the first character of the container file citation in the message.
             attr_accessor start_index: Integer
 
+            # The type of the container file citation. Always `container_file_citation`.
             attr_accessor type: :container_file_citation
 
+            # @param container_id
+            #   The ID of the container file.
+            # @param end_index
+            #   The index of the last character of the container file citation in the message.
+            # @param file_id
+            #   The ID of the file.
+            # @param filename
+            #   The filename of the container file cited.
+            # @param start_index
+            #   The index of the first character of the container file citation in the message.
+            # @param type
+            #   The type of the container file citation. Always `container_file_citation`.
             def initialize: (
               container_id: String,
               end_index: Integer,
@@ -162,12 +216,21 @@ module OpenAI
             { file_id: String, index: Integer, ?type: :file_path }
 
           class FilePath < OpenAI::Internal::Type::BaseModel
+            # The ID of the file.
             attr_accessor file_id: String
 
+            # The index of the file in the list of files.
             attr_accessor index: Integer
 
+            # The type of the file path. Always `file_path`.
             attr_accessor type: :file_path
 
+            # @param file_id
+            #   The ID of the file.
+            # @param index
+            #   The index of the file in the list of files.
+            # @param type
+            #   The type of the file path. Always `file_path`.
             def initialize: (
               file_id: String,
               index: Integer,

data/sig/openai/models/beta/beta_response_output_text_annotation_added_event.rbs

@@ -16,22 +16,46 @@ module OpenAI
         }
 
       class BetaResponseOutputTextAnnotationAddedEvent < OpenAI::Internal::Type::BaseModel
+        # The annotation object being added. (See annotation schema for details.)
         attr_accessor annotation: OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent::annotation?
 
+        # The index of the annotation within the content part.
         attr_accessor annotation_index: Integer
 
+        # The index of the content part within the output item.
         attr_accessor content_index: Integer
 
+        # The unique identifier of the item to which the annotation is being added.
         attr_accessor item_id: String
 
+        # The index of the output item in the response's output array.
         attr_accessor output_index: Integer
 
+        # The sequence number of this event.
         attr_accessor sequence_number: Integer
 
+        # The type of the event. Always 'response.output_text.annotation.added'.
         attr_accessor type: :"response.output_text.annotation.added"
 
+        # The agent that owns this multi-agent streaming event.
         attr_accessor agent: OpenAI::Beta::BetaResponseOutputTextAnnotationAddedEvent::Agent?
 
+        # @param annotation
+        #   The annotation object being added. (See annotation schema for details.)
+        # @param annotation_index
+        #   The index of the annotation within the content part.
+        # @param content_index
+        #   The index of the content part within the output item.
+        # @param item_id
+        #   The unique identifier of the item to which the annotation is being added.
+        # @param output_index
+        #   The index of the output item in the response's output array.
+        # @param sequence_number
+        #   The sequence number of this event.
+        # @param agent
+        #   The agent that owns this multi-agent streaming event.
+        # @param type
+        #   The type of the event. Always 'response.output_text.annotation.added'.
         def initialize: (
           annotation: OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent::annotation?,
           annotation_index: Integer,
@@ -72,14 +96,26 @@ module OpenAI
             }
 
           class FileCitation < OpenAI::Internal::Type::BaseModel
+            # The ID of the file.
             attr_accessor file_id: String
 
+            # The filename of the file cited.
             attr_accessor filename: String
 
+            # The index of the file in the list of files.
             attr_accessor index: Integer
 
+            # The type of the file citation. Always `file_citation`.
             attr_accessor type: :file_citation
 
+            # @param file_id
+            #   The ID of the file.
+            # @param filename
+            #   The filename of the file cited.
+            # @param index
+            #   The index of the file in the list of files.
+            # @param type
+            #   The type of the file citation. Always `file_citation`.
             def initialize: (
               file_id: String,
               filename: String,
@@ -105,16 +141,31 @@ module OpenAI
             }
 
           class URLCitation < OpenAI::Internal::Type::BaseModel
+            # The index of the last character of the URL citation in the message.
             attr_accessor end_index: Integer
 
+            # The index of the first character of the URL citation in the message.
             attr_accessor start_index: Integer
 
+            # The title of the web resource.
             attr_accessor title: String
 
+            # The type of the URL citation. Always `url_citation`.
             attr_accessor type: :url_citation
 
+            # The URL of the web resource.
             attr_accessor url: String
 
+            # @param end_index
+            #   The index of the last character of the URL citation in the message.
+            # @param start_index
+            #   The index of the first character of the URL citation in the message.
+            # @param title
+            #   The title of the web resource.
+            # @param url
+            #   The URL of the web resource.
+            # @param type
+            #   The type of the URL citation. Always `url_citation`.
             def initialize: (
               end_index: Integer,
               start_index: Integer,
@@ -143,18 +194,36 @@ module OpenAI
             }
 
           class ContainerFileCitation < OpenAI::Internal::Type::BaseModel
+            # The ID of the container file.
             attr_accessor container_id: String
 
+            # The index of the last character of the container file citation in the message.
             attr_accessor end_index: Integer
 
+            # The ID of the file.
             attr_accessor file_id: String
 
+            # The filename of the container file cited.
             attr_accessor filename: String
 
+            # The index of the first character of the container file citation in the message.
             attr_accessor start_index: Integer
 
+            # The type of the container file citation. Always `container_file_citation`.
             attr_accessor type: :container_file_citation
 
+            # @param container_id
+            #   The ID of the container file.
+            # @param end_index
+            #   The index of the last character of the container file citation in the message.
+            # @param file_id
+            #   The ID of the file.
+            # @param filename
+            #   The filename of the container file cited.
+            # @param start_index
+            #   The index of the first character of the container file citation in the message.
+            # @param type
+            #   The type of the container file citation. Always `container_file_citation`.
             def initialize: (
               container_id: String,
               end_index: Integer,
@@ -178,12 +247,21 @@ module OpenAI
             { file_id: String, index: Integer, ?type: :file_path }
 
           class FilePath < OpenAI::Internal::Type::BaseModel
+            # The ID of the file.
             attr_accessor file_id: String
 
+            # The index of the file in the list of files.
             attr_accessor index: Integer
 
+            # The type of the file path. Always `file_path`.
             attr_accessor type: :file_path
 
+            # @param file_id
+            #   The ID of the file.
+            # @param index
+            #   The index of the file in the list of files.
+            # @param type
+            #   The type of the file path. Always `file_path`.
             def initialize: (
               file_id: String,
               index: Integer,
@@ -203,8 +281,11 @@ module OpenAI
         type agent = { agent_name: String }
 
         class Agent < OpenAI::Internal::Type::BaseModel
+          # The canonical name of the agent that produced this item.
           attr_accessor agent_name: String
 
+          # @param agent_name
+          #   The canonical name of the agent that produced this item.
           def initialize: (agent_name: String) -> void
 
           def to_hash: -> { agent_name: String }

data/sig/openai/models/beta/beta_response_prompt.rbs

@@ -11,12 +11,25 @@ module OpenAI
         }
 
       class BetaResponsePrompt < OpenAI::Internal::Type::BaseModel
+        # The unique identifier of the prompt template to use.
         attr_accessor id: String
 
+        # 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.
         attr_accessor variables: ::Hash[Symbol, OpenAI::Models::Beta::BetaResponsePrompt::variable]?
 
+        # Optional version of the prompt template.
         attr_accessor version: String?
 
+        # @param id
+        #   The unique identifier of the prompt template to use.
+        # @param 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.
+        # @param version
+        #   Optional version of the prompt template.
         def initialize: (
           id: String,
           ?variables: ::Hash[Symbol, OpenAI::Models::Beta::BetaResponsePrompt::variable]?,

data/sig/openai/models/beta/beta_response_queued_event.rbs

@@ -12,14 +12,26 @@ module OpenAI
         }
 
       class BetaResponseQueuedEvent < OpenAI::Internal::Type::BaseModel
+        # The full response object that is queued.
         attr_accessor response: OpenAI::Beta::BetaResponse
 
+        # The sequence number for this event.
         attr_accessor sequence_number: Integer
 
+        # The type of the event. Always 'response.queued'.
         attr_accessor type: :"response.queued"
 
+        # The agent that owns this multi-agent streaming event.
         attr_accessor agent: OpenAI::Beta::BetaResponseQueuedEvent::Agent?
 
+        # @param response
+        #   The full response object that is queued.
+        # @param sequence_number
+        #   The sequence number for this event.
+        # @param agent
+        #   The agent that owns this multi-agent streaming event.
+        # @param type
+        #   The type of the event. Always 'response.queued'.
         def initialize: (
           response: OpenAI::Beta::BetaResponse,
           sequence_number: Integer,
@@ -37,8 +49,11 @@ module OpenAI
         type agent = { agent_name: String }
 
         class Agent < OpenAI::Internal::Type::BaseModel
+          # The canonical name of the agent that produced this item.
           attr_accessor agent_name: String
 
+          # @param agent_name
+          #   The canonical name of the agent that produced this item.
           def initialize: (agent_name: String) -> void
 
           def to_hash: -> { agent_name: String }

data/sig/openai/models/beta/beta_response_reasoning_item.rbs

@@ -15,28 +15,68 @@ module OpenAI
         }
 
       class BetaResponseReasoningItem < OpenAI::Internal::Type::BaseModel
+        # The unique identifier of the reasoning content.
         attr_accessor id: String
 
+        # Reasoning summary content.
         attr_accessor summary: ::Array[OpenAI::Beta::BetaResponseReasoningItem::Summary]
 
+        # The type of the object. Always `reasoning`.
         attr_accessor type: :reasoning
 
+        # The agent that produced this item.
         attr_accessor agent: OpenAI::Beta::BetaResponseReasoningItem::Agent?
 
+        # Reasoning text content.
         attr_reader content: ::Array[OpenAI::Beta::BetaResponseReasoningItem::Content]?
 
+        # Reasoning text content.
         def content=: (
           ::Array[OpenAI::Beta::BetaResponseReasoningItem::Content]
         ) -> ::Array[OpenAI::Beta::BetaResponseReasoningItem::Content]
 
+        # 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.
+        #
+        # 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.
         attr_accessor encrypted_content: String?
 
+        # The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+        # Populated when items are returned via API.
         attr_reader status: OpenAI::Models::Beta::BetaResponseReasoningItem::status?
 
+        # The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+        # Populated when items are returned via API.
         def status=: (
           OpenAI::Models::Beta::BetaResponseReasoningItem::status
         ) -> OpenAI::Models::Beta::BetaResponseReasoningItem::status
 
+        # @param id
+        #   The unique identifier of the reasoning content.
+        # @param summary
+        #   Reasoning summary content.
+        # @param agent
+        #   The agent that produced this item.
+        # @param content
+        #   Reasoning text content.
+        # @param encrypted_content
+        #   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.
+        #
+        #   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 status
+        #   The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+        #   Populated when items are returned via API.
+        # @param type
+        #   The type of the object. Always `reasoning`.
         def initialize: (
           id: String,
           summary: ::Array[OpenAI::Beta::BetaResponseReasoningItem::Summary],
@@ -60,10 +100,16 @@ module OpenAI
         type summary = { text: String, ?type: :summary_text }
 
         class Summary < OpenAI::Internal::Type::BaseModel
+          # A summary of the reasoning output from the model so far.
           attr_accessor text: String
 
+          # The type of the object. Always `summary_text`.
           attr_accessor type: :summary_text
 
+          # @param text
+          #   A summary of the reasoning output from the model so far.
+          # @param type
+          #   The type of the object. Always `summary_text`.
           def initialize: (text: String, ?type: :summary_text) -> void
 
           def to_hash: -> { text: String, ?type: :summary_text }
@@ -72,8 +118,11 @@ module OpenAI
         type agent = { agent_name: String }
 
         class Agent < OpenAI::Internal::Type::BaseModel
+          # The canonical name of the agent that produced this item.
           attr_accessor agent_name: String
 
+          # @param agent_name
+          #   The canonical name of the agent that produced this item.
           def initialize: (agent_name: String) -> void
 
           def to_hash: -> { agent_name: String }
@@ -82,10 +131,16 @@ module OpenAI
         type content = { text: String, ?type: :reasoning_text }
 
         class Content < OpenAI::Internal::Type::BaseModel
+          # The reasoning text from the model.
           attr_accessor text: String
 
+          # The type of the reasoning text. Always `reasoning_text`.
           attr_accessor type: :reasoning_text
 
+          # @param text
+          #   The reasoning text from the model.
+          # @param type
+          #   The type of the reasoning text. Always `reasoning_text`.
           def initialize: (text: String, ?type: :reasoning_text) -> void
 
           def to_hash: -> { text: String, ?type: :reasoning_text }