openai 0.91.0 → 0.93.0

data/sig/openai/models/responses/response_output_message.rbs

@@ -12,18 +12,44 @@ module OpenAI
         }
 
       class ResponseOutputMessage < 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::Responses::ResponseOutputMessage::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::Responses::ResponseOutputMessage::status
 
+        # The type of the output message. Always `message`.
         attr_accessor type: :message
 
+        # 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::Responses::ResponseOutputMessage::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 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::Responses::ResponseOutputMessage::content],

data/sig/openai/models/responses/response_output_refusal.rbs

@@ -4,10 +4,16 @@ module OpenAI
       type response_output_refusal = { refusal: String, ?type: :refusal }
 
       class ResponseOutputRefusal < 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/responses/response_output_text.rbs

@@ -10,10 +10,13 @@ module OpenAI
         }
 
       class ResponseOutputText < OpenAI::Internal::Type::BaseModel
+        # The annotations of the text output.
         attr_accessor annotations: ::Array[OpenAI::Models::Responses::ResponseOutputText::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::Responses::ResponseOutputText::Logprob]?
@@ -22,6 +25,12 @@ module OpenAI
           ::Array[OpenAI::Responses::ResponseOutputText::Logprob]
         ) -> ::Array[OpenAI::Responses::ResponseOutputText::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::Responses::ResponseOutputText::annotation],
           text: String,
@@ -54,14 +63,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,
@@ -87,16 +108,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,
@@ -125,18 +161,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,
@@ -160,12 +214,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/responses/response_output_text_annotation_added_event.rbs

@@ -13,20 +13,41 @@ module OpenAI
         }
 
       class ResponseOutputTextAnnotationAddedEvent < OpenAI::Internal::Type::BaseModel
+        # The annotation object being added. (See annotation schema for details.)
         attr_accessor annotation: OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent::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"
 
+        # @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 type
+        #   The type of the event. Always 'response.output_text.annotation.added'.
         def initialize: (
           annotation: OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent::annotation?,
           annotation_index: Integer,
@@ -65,14 +86,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,
@@ -98,16 +131,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,
@@ -136,18 +184,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,
@@ -171,12 +237,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/responses/response_prompt.rbs

@@ -9,12 +9,25 @@ module OpenAI
         }
 
       class ResponsePrompt < 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::Responses::ResponsePrompt::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::Responses::ResponsePrompt::variable]?,

data/sig/openai/models/responses/response_queued_event.rbs

@@ -9,12 +9,21 @@ module OpenAI
         }
 
       class ResponseQueuedEvent < OpenAI::Internal::Type::BaseModel
+        # The full response object that is queued.
         attr_accessor response: OpenAI::Responses::Response
 
+        # The sequence number for this event.
         attr_accessor sequence_number: Integer
 
+        # The type of the event. Always 'response.queued'.
         attr_accessor type: :"response.queued"
 
+        # @param response
+        #   The full response object that is queued.
+        # @param sequence_number
+        #   The sequence number for this event.
+        # @param type
+        #   The type of the event. Always 'response.queued'.
         def initialize: (
           response: OpenAI::Responses::Response,
           sequence_number: Integer,

data/sig/openai/models/responses/response_reasoning_item.rbs

@@ -12,26 +12,63 @@ module OpenAI
         }
 
       class ResponseReasoningItem < OpenAI::Internal::Type::BaseModel
+        # The unique identifier of the reasoning content.
         attr_accessor id: String
 
+        # Reasoning summary content.
         attr_accessor summary: ::Array[OpenAI::Responses::ResponseReasoningItem::Summary]
 
+        # The type of the object. Always `reasoning`.
         attr_accessor type: :reasoning
 
+        # Reasoning text content.
         attr_reader content: ::Array[OpenAI::Responses::ResponseReasoningItem::Content]?
 
+        # Reasoning text content.
         def content=: (
           ::Array[OpenAI::Responses::ResponseReasoningItem::Content]
         ) -> ::Array[OpenAI::Responses::ResponseReasoningItem::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::Responses::ResponseReasoningItem::status?
 
+        # The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+        # Populated when items are returned via API.
         def status=: (
           OpenAI::Models::Responses::ResponseReasoningItem::status
         ) -> OpenAI::Models::Responses::ResponseReasoningItem::status
 
+        # @param id
+        #   The unique identifier of the reasoning content.
+        # @param summary
+        #   Reasoning summary content.
+        # @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::Responses::ResponseReasoningItem::Summary],
@@ -53,10 +90,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 }
@@ -65,10 +108,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 }

data/sig/openai/models/responses/response_reasoning_summary_part_added_event.rbs

@@ -12,18 +12,36 @@ module OpenAI
         }
 
       class ResponseReasoningSummaryPartAddedEvent < OpenAI::Internal::Type::BaseModel
+        # The ID of the item this summary part is associated with.
         attr_accessor item_id: String
 
+        # The index of the output item this summary part is associated with.
         attr_accessor output_index: Integer
 
+        # The summary part that was added.
         attr_accessor part: OpenAI::Responses::ResponseReasoningSummaryPartAddedEvent::Part
 
+        # The sequence number of this event.
         attr_accessor sequence_number: Integer
 
+        # The index of the summary part within the reasoning summary.
         attr_accessor summary_index: Integer
 
+        # The type of the event. Always `response.reasoning_summary_part.added`.
         attr_accessor type: :"response.reasoning_summary_part.added"
 
+        # @param item_id
+        #   The ID of the item this summary part is associated with.
+        # @param output_index
+        #   The index of the output item this summary part is associated with.
+        # @param part
+        #   The summary part that was added.
+        # @param sequence_number
+        #   The sequence number of this event.
+        # @param summary_index
+        #   The index of the summary part within the reasoning summary.
+        # @param type
+        #   The type of the event. Always `response.reasoning_summary_part.added`.
         def initialize: (
           item_id: String,
           output_index: Integer,
@@ -45,10 +63,16 @@ module OpenAI
         type part = { text: String, ?type: :summary_text }
 
         class Part < OpenAI::Internal::Type::BaseModel
+          # The text of the summary part.
           attr_accessor text: String
 
+          # The type of the summary part. Always `summary_text`.
           attr_accessor type: :summary_text
 
+          # @param text
+          #   The text of the summary part.
+          # @param type
+          #   The type of the summary part. Always `summary_text`.
           def initialize: (text: String, ?type: :summary_text) -> void
 
           def to_hash: -> { text: String, ?type: :summary_text }

data/sig/openai/models/responses/response_reasoning_summary_part_done_event.rbs

@@ -13,24 +13,49 @@ module OpenAI
         }
 
       class ResponseReasoningSummaryPartDoneEvent < OpenAI::Internal::Type::BaseModel
+        # The ID of the item this summary part is associated with.
         attr_accessor item_id: String
 
+        # The index of the output item this summary part is associated with.
         attr_accessor output_index: Integer
 
+        # The completed summary part.
         attr_accessor part: OpenAI::Responses::ResponseReasoningSummaryPartDoneEvent::Part
 
+        # The sequence number of this event.
         attr_accessor sequence_number: Integer
 
+        # The index of the summary part within the reasoning summary.
         attr_accessor summary_index: Integer
 
+        # The type of the event. Always `response.reasoning_summary_part.done`.
         attr_accessor type: :"response.reasoning_summary_part.done"
 
+        # The completion status of the summary part. Omitted when the part completed
+        # normally and set to `incomplete` when generation was interrupted.
         attr_reader status: OpenAI::Models::Responses::ResponseReasoningSummaryPartDoneEvent::status?
 
+        # The completion status of the summary part. Omitted when the part completed
+        # normally and set to `incomplete` when generation was interrupted.
         def status=: (
           OpenAI::Models::Responses::ResponseReasoningSummaryPartDoneEvent::status
         ) -> OpenAI::Models::Responses::ResponseReasoningSummaryPartDoneEvent::status
 
+        # @param item_id
+        #   The ID of the item this summary part is associated with.
+        # @param output_index
+        #   The index of the output item this summary part is associated with.
+        # @param part
+        #   The completed summary part.
+        # @param sequence_number
+        #   The sequence number of this event.
+        # @param summary_index
+        #   The index of the summary part within the reasoning summary.
+        # @param status
+        #   The completion status of the summary part. Omitted when the part completed
+        #   normally and set to `incomplete` when generation was interrupted.
+        # @param type
+        #   The type of the event. Always `response.reasoning_summary_part.done`.
         def initialize: (
           item_id: String,
           output_index: Integer,
@@ -54,10 +79,16 @@ module OpenAI
         type part = { text: String, ?type: :summary_text }
 
         class Part < OpenAI::Internal::Type::BaseModel
+          # The text of the summary part.
           attr_accessor text: String
 
+          # The type of the summary part. Always `summary_text`.
           attr_accessor type: :summary_text
 
+          # @param text
+          #   The text of the summary part.
+          # @param type
+          #   The type of the summary part. Always `summary_text`.
           def initialize: (text: String, ?type: :summary_text) -> void
 
           def to_hash: -> { text: String, ?type: :summary_text }

data/sig/openai/models/responses/response_reasoning_summary_text_delta_event.rbs

@@ -12,18 +12,36 @@ module OpenAI
         }
 
       class ResponseReasoningSummaryTextDeltaEvent < OpenAI::Internal::Type::BaseModel
+        # The text delta that was added to the summary.
         attr_accessor delta: String
 
+        # The ID of the item this summary text delta is associated with.
         attr_accessor item_id: String
 
+        # The index of the output item this summary text delta is associated with.
         attr_accessor output_index: Integer
 
+        # The sequence number of this event.
         attr_accessor sequence_number: Integer
 
+        # The index of the summary part within the reasoning summary.
         attr_accessor summary_index: Integer
 
+        # The type of the event. Always `response.reasoning_summary_text.delta`.
         attr_accessor type: :"response.reasoning_summary_text.delta"
 
+        # @param delta
+        #   The text delta that was added to the summary.
+        # @param item_id
+        #   The ID of the item this summary text delta is associated with.
+        # @param output_index
+        #   The index of the output item this summary text delta is associated with.
+        # @param sequence_number
+        #   The sequence number of this event.
+        # @param summary_index
+        #   The index of the summary part within the reasoning summary.
+        # @param type
+        #   The type of the event. Always `response.reasoning_summary_text.delta`.
         def initialize: (
           delta: String,
           item_id: String,