openai 0.42.0 → 0.45.0

data/rbi/openai/models/responses/response_function_web_search.rbi

@@ -17,7 +17,7 @@ module OpenAI
         attr_accessor :id
 
         # An object describing the specific action taken in this web search call. Includes
-        # details on how the model used the web (search, open_page, find).
+        # details on how the model used the web (search, open_page, find_in_page).
         sig do
           returns(
             T.any(
@@ -62,7 +62,7 @@ module OpenAI
           # The unique ID of the web search tool call.
           id:,
           # An object describing the specific action taken in this web search call. Includes
-          # details on how the model used the web (search, open_page, find).
+          # details on how the model used the web (search, open_page, find_in_page).
           action:,
           # The status of the web search tool call.
           status:,
@@ -91,7 +91,7 @@ module OpenAI
         end
 
         # An object describing the specific action taken in this web search call. Includes
-        # details on how the model used the web (search, open_page, find).
+        # details on how the model used the web (search, open_page, find_in_page).
         module Action
           extend OpenAI::Internal::Type::Union
 
@@ -113,7 +113,7 @@ module OpenAI
                 )
               end
 
-            # The search query.
+            # [DEPRECATED] The search query.
             sig { returns(String) }
             attr_accessor :query
 
@@ -121,6 +121,13 @@ module OpenAI
             sig { returns(Symbol) }
             attr_accessor :type
 
+            # The search queries.
+            sig { returns(T.nilable(T::Array[String])) }
+            attr_reader :queries
+
+            sig { params(queries: T::Array[String]).void }
+            attr_writer :queries
+
             # The sources used in the search.
             sig do
               returns(
@@ -147,6 +154,7 @@ module OpenAI
             sig do
               params(
                 query: String,
+                queries: T::Array[String],
                 sources:
                   T::Array[
                     OpenAI::Responses::ResponseFunctionWebSearch::Action::Search::Source::OrHash
@@ -155,8 +163,10 @@ module OpenAI
               ).returns(T.attached_class)
             end
             def self.new(
-              # The search query.
+              # [DEPRECATED] The search query.
               query:,
+              # The search queries.
+              queries: nil,
               # The sources used in the search.
               sources: nil,
               # The action type.
@@ -169,6 +179,7 @@ module OpenAI
                 {
                   query: String,
                   type: Symbol,
+                  queries: T::Array[String],
                   sources:
                     T::Array[
                       OpenAI::Responses::ResponseFunctionWebSearch::Action::Search::Source
@@ -228,20 +239,24 @@ module OpenAI
             attr_accessor :type
 
             # The URL opened by the model.
-            sig { returns(String) }
+            sig { returns(T.nilable(String)) }
             attr_accessor :url
 
             # Action type "open_page" - Opens a specific URL from search results.
-            sig { params(url: String, type: Symbol).returns(T.attached_class) }
+            sig do
+              params(url: T.nilable(String), type: Symbol).returns(
+                T.attached_class
+              )
+            end
             def self.new(
               # The URL opened by the model.
-              url:,
+              url: nil,
               # The action type.
               type: :open_page
             )
             end
 
-            sig { override.returns({ type: Symbol, url: String }) }
+            sig { override.returns({ type: Symbol, url: T.nilable(String) }) }
             def to_hash
             end
           end
@@ -267,7 +282,7 @@ module OpenAI
             sig { returns(String) }
             attr_accessor :url
 
-            # Action type "find": Searches for a pattern within a loaded page.
+            # Action type "find_in_page": Searches for a pattern within a loaded page.
             sig do
               params(pattern: String, url: String, type: Symbol).returns(
                 T.attached_class
@@ -279,7 +294,7 @@ module OpenAI
               # The URL of the page searched for the pattern.
               url:,
               # The action type.
-              type: :find
+              type: :find_in_page
             )
             end
 

data/rbi/openai/models/responses/response_input_item.rbi

@@ -1308,6 +1308,16 @@ module OpenAI
           sig { returns(T.nilable(Integer)) }
           attr_accessor :max_output_length
 
+          # The status of the shell call output.
+          sig do
+            returns(
+              T.nilable(
+                OpenAI::Responses::ResponseInputItem::ShellCallOutput::Status::OrSymbol
+              )
+            )
+          end
+          attr_accessor :status
+
           # The streamed output items emitted by a shell tool call.
           sig do
             params(
@@ -1318,6 +1328,10 @@ module OpenAI
                 ],
               id: T.nilable(String),
               max_output_length: T.nilable(Integer),
+              status:
+                T.nilable(
+                  OpenAI::Responses::ResponseInputItem::ShellCallOutput::Status::OrSymbol
+                ),
               type: Symbol
             ).returns(T.attached_class)
           end
@@ -1333,6 +1347,8 @@ module OpenAI
             # The maximum number of UTF-8 characters captured for this shell call's combined
             # output.
             max_output_length: nil,
+            # The status of the shell call output.
+            status: nil,
             # The type of the item. Always `shell_call_output`.
             type: :shell_call_output
           )
@@ -1348,12 +1364,56 @@ module OpenAI
                   ],
                 type: Symbol,
                 id: T.nilable(String),
-                max_output_length: T.nilable(Integer)
+                max_output_length: T.nilable(Integer),
+                status:
+                  T.nilable(
+                    OpenAI::Responses::ResponseInputItem::ShellCallOutput::Status::OrSymbol
+                  )
               }
             )
           end
           def to_hash
           end
+
+          # The status of the shell call output.
+          module Status
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  OpenAI::Responses::ResponseInputItem::ShellCallOutput::Status
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            IN_PROGRESS =
+              T.let(
+                :in_progress,
+                OpenAI::Responses::ResponseInputItem::ShellCallOutput::Status::TaggedSymbol
+              )
+            COMPLETED =
+              T.let(
+                :completed,
+                OpenAI::Responses::ResponseInputItem::ShellCallOutput::Status::TaggedSymbol
+              )
+            INCOMPLETE =
+              T.let(
+                :incomplete,
+                OpenAI::Responses::ResponseInputItem::ShellCallOutput::Status::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Responses::ResponseInputItem::ShellCallOutput::Status::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
         end
 
         class ApplyPatchCall < OpenAI::Internal::Type::BaseModel

data/rbi/openai/models/responses/response_output_text.rbi

@@ -104,7 +104,7 @@ module OpenAI
         def to_hash
         end
 
-        # A citation to a file.
+        # An annotation that applies to a span of output text.
         module Annotation
           extend OpenAI::Internal::Type::Union
 

data/rbi/openai/models/responses/tool.rbi

@@ -718,6 +718,7 @@ module OpenAI
               sig { params(file_ids: T::Array[String]).void }
               attr_writer :file_ids
 
+              # The memory limit for the code interpreter container.
               sig do
                 returns(
                   T.nilable(
@@ -742,6 +743,7 @@ module OpenAI
               def self.new(
                 # An optional list of uploaded files to make available to your code.
                 file_ids: nil,
+                # The memory limit for the code interpreter container.
                 memory_limit: nil,
                 # Always `auto`.
                 type: :auto
@@ -763,6 +765,7 @@ module OpenAI
               def to_hash
               end
 
+              # The memory limit for the code interpreter container.
               module MemoryLimit
                 extend OpenAI::Internal::Type::Enum
 
@@ -833,6 +836,23 @@ module OpenAI
           sig { returns(Symbol) }
           attr_accessor :type
 
+          # Whether to generate a new image or edit an existing image. Default: `auto`.
+          sig do
+            returns(
+              T.nilable(
+                OpenAI::Responses::Tool::ImageGeneration::Action::OrSymbol
+              )
+            )
+          end
+          attr_reader :action
+
+          sig do
+            params(
+              action: OpenAI::Responses::Tool::ImageGeneration::Action::OrSymbol
+            ).void
+          end
+          attr_writer :action
+
           # Background type for the generated image. One of `transparent`, `opaque`, or
           # `auto`. Default: `auto`.
           sig do
@@ -1000,6 +1020,8 @@ module OpenAI
           # A tool that generates images using the GPT image models.
           sig do
             params(
+              action:
+                OpenAI::Responses::Tool::ImageGeneration::Action::OrSymbol,
               background:
                 OpenAI::Responses::Tool::ImageGeneration::Background::OrSymbol,
               input_fidelity:
@@ -1026,6 +1048,8 @@ module OpenAI
             ).returns(T.attached_class)
           end
           def self.new(
+            # Whether to generate a new image or edit an existing image. Default: `auto`.
+            action: nil,
             # Background type for the generated image. One of `transparent`, `opaque`, or
             # `auto`. Default: `auto`.
             background: nil,
@@ -1064,6 +1088,8 @@ module OpenAI
             override.returns(
               {
                 type: Symbol,
+                action:
+                  OpenAI::Responses::Tool::ImageGeneration::Action::OrSymbol,
                 background:
                   OpenAI::Responses::Tool::ImageGeneration::Background::OrSymbol,
                 input_fidelity:
@@ -1092,6 +1118,43 @@ module OpenAI
           def to_hash
           end
 
+          # Whether to generate a new image or edit an existing image. Default: `auto`.
+          module Action
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(Symbol, OpenAI::Responses::Tool::ImageGeneration::Action)
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            GENERATE =
+              T.let(
+                :generate,
+                OpenAI::Responses::Tool::ImageGeneration::Action::TaggedSymbol
+              )
+            EDIT =
+              T.let(
+                :edit,
+                OpenAI::Responses::Tool::ImageGeneration::Action::TaggedSymbol
+              )
+            AUTO =
+              T.let(
+                :auto,
+                OpenAI::Responses::Tool::ImageGeneration::Action::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Responses::Tool::ImageGeneration::Action::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
           # Background type for the generated image. One of `transparent`, `opaque`, or
           # `auto`. Default: `auto`.
           module Background
@@ -1252,6 +1315,11 @@ module OpenAI
                 :"gpt-image-1-mini",
                 OpenAI::Responses::Tool::ImageGeneration::Model::TaggedSymbol
               )
+            GPT_IMAGE_1_5 =
+              T.let(
+                :"gpt-image-1.5",
+                OpenAI::Responses::Tool::ImageGeneration::Model::TaggedSymbol
+              )
           end
 
           # Moderation level for the generated image. Default: `auto`.

data/rbi/openai/models/video_create_error.rbi

@@ -8,14 +8,22 @@ module OpenAI
           T.any(OpenAI::VideoCreateError, OpenAI::Internal::AnyHash)
         end
 
+      # A machine-readable error code that was returned.
       sig { returns(String) }
       attr_accessor :code
 
+      # A human-readable description of the error that was returned.
       sig { returns(String) }
       attr_accessor :message
 
+      # An error that occurred while generating the response.
       sig { params(code: String, message: String).returns(T.attached_class) }
-      def self.new(code:, message:)
+      def self.new(
+        # A machine-readable error code that was returned.
+        code:,
+        # A human-readable description of the error that was returned.
+        message:
+      )
       end
 
       sig { override.returns({ code: String, message: String }) }

data/rbi/openai/resources/audio/speech.rbi

@@ -26,9 +26,10 @@ module OpenAI
           # One of the available [TTS models](https://platform.openai.com/docs/models#tts):
           # `tts-1`, `tts-1-hd`, `gpt-4o-mini-tts`, or `gpt-4o-mini-tts-2025-12-15`.
           model:,
-          # The voice to use when generating the audio. Supported voices are `alloy`, `ash`,
-          # `ballad`, `coral`, `echo`, `fable`, `onyx`, `nova`, `sage`, `shimmer`, and
-          # `verse`. Previews of the voices are available in the
+          # The voice to use when generating the audio. Supported built-in voices are
+          # `alloy`, `ash`, `ballad`, `coral`, `echo`, `fable`, `onyx`, `nova`, `sage`,
+          # `shimmer`, `verse`, `marin`, and `cedar`. Previews of the voices are available
+          # in the
           # [Text to speech guide](https://platform.openai.com/docs/guides/text-to-speech#voice-options).
           voice:,
           # Control the voice of your generated audio with additional instructions. Does not

data/rbi/openai/resources/files.rbi

@@ -4,8 +4,8 @@ module OpenAI
   module Resources
     class Files
       # Upload a file that can be used across various endpoints. Individual files can be
-      # up to 512 MB, and the size of all files uploaded by one organization can be up
-      # to 1 TB.
+      # up to 512 MB, and each project can store up to 2.5 TB of files in total. There
+      # is no organization-wide storage limit.
       #
       # - The Assistants API supports files up to 2 million tokens and of specific file
       #   types. See the
@@ -34,10 +34,14 @@ module OpenAI
       def create(
         # The File object (not file name) to be uploaded.
         file:,
-        # The intended purpose of the uploaded file. One of: - `assistants`: Used in the
-        # Assistants API - `batch`: Used in the Batch API - `fine-tune`: Used for
-        # fine-tuning - `vision`: Images used for vision fine-tuning - `user_data`:
-        # Flexible file type for any purpose - `evals`: Used for eval data sets
+        # The intended purpose of the uploaded file. One of:
+        #
+        # - `assistants`: Used in the Assistants API
+        # - `batch`: Used in the Batch API
+        # - `fine-tune`: Used for fine-tuning
+        # - `vision`: Images used for vision fine-tuning
+        # - `user_data`: Flexible file type for any purpose
+        # - `evals`: Used for eval data sets
         purpose:,
         # The expiration policy for a file. By default, files with `purpose=batch` expire
         # after 30 days and all other files are persisted until they are manually deleted.

data/rbi/openai/resources/images.rbi

@@ -45,7 +45,8 @@ module OpenAI
       # See {OpenAI::Resources::Images#edit_stream_raw} for streaming counterpart.
       #
       # Creates an edited or extended image given one or more source images and a
-      # prompt. This endpoint only supports `gpt-image-1` and `dall-e-2`.
+      # prompt. This endpoint supports GPT Image models (`gpt-image-1.5`, `gpt-image-1`,
+      # and `gpt-image-1-mini`) and `dall-e-2`.
       sig do
         params(
           image: OpenAI::ImageEditParams::Image::Variants,
@@ -148,7 +149,8 @@ module OpenAI
       # See {OpenAI::Resources::Images#edit} for non-streaming counterpart.
       #
       # Creates an edited or extended image given one or more source images and a
-      # prompt. This endpoint only supports `gpt-image-1` and `dall-e-2`.
+      # prompt. This endpoint supports GPT Image models (`gpt-image-1.5`, `gpt-image-1`,
+      # and `gpt-image-1-mini`) and `dall-e-2`.
       sig do
         params(
           image: OpenAI::ImageEditParams::Image::Variants,

data/rbi/openai/resources/responses/input_tokens.rbi

@@ -97,9 +97,7 @@ module OpenAI
           # - [Text inputs and outputs](https://platform.openai.com/docs/guides/text)
           # - [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs)
           text: nil,
-          # How the model should select which tool (or tools) to use when generating a
-          # response. See the `tools` parameter to see how to specify which tools the model
-          # can call.
+          # Controls which tool the model should use, if any.
           tool_choice: nil,
           # An array of tools the model may call while generating a response. You can
           # specify which tool to use by setting the `tool_choice` parameter.

data/sig/openai/models/realtime/response_function_call_arguments_done_event.rbs

@@ -7,6 +7,7 @@ module OpenAI
           call_id: String,
           event_id: String,
           item_id: String,
+          name: String,
           output_index: Integer,
           response_id: String,
           type: :"response.function_call_arguments.done"
@@ -21,6 +22,8 @@ module OpenAI
 
         attr_accessor item_id: String
 
+        attr_accessor name: String
+
         attr_accessor output_index: Integer
 
         attr_accessor response_id: String
@@ -32,6 +35,7 @@ module OpenAI
           call_id: String,
           event_id: String,
           item_id: String,
+          name: String,
           output_index: Integer,
           response_id: String,
           ?type: :"response.function_call_arguments.done"
@@ -42,6 +46,7 @@ module OpenAI
           call_id: String,
           event_id: String,
           item_id: String,
+          name: String,
           output_index: Integer,
           response_id: String,
           type: :"response.function_call_arguments.done"

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

@@ -18,6 +18,7 @@ module OpenAI
           tools: ::Array[OpenAI::Models::Responses::tool],
           top_p: Float?,
           background: bool?,
+          completed_at: Float?,
           conversation: OpenAI::Responses::Response::Conversation?,
           max_output_tokens: Integer?,
           max_tool_calls: Integer?,
@@ -67,6 +68,8 @@ module OpenAI
 
         attr_accessor background: bool?
 
+        attr_accessor completed_at: Float?
+
         attr_accessor conversation: OpenAI::Responses::Response::Conversation?
 
         attr_accessor max_output_tokens: Integer?
@@ -132,6 +135,7 @@ module OpenAI
           tools: ::Array[OpenAI::Models::Responses::tool],
           top_p: Float?,
           ?background: bool?,
+          ?completed_at: Float?,
           ?conversation: OpenAI::Responses::Response::Conversation?,
           ?max_output_tokens: Integer?,
           ?max_tool_calls: Integer?,
@@ -167,6 +171,7 @@ module OpenAI
           tools: ::Array[OpenAI::Models::Responses::tool],
           top_p: Float?,
           background: bool?,
+          completed_at: Float?,
           conversation: OpenAI::Responses::Response::Conversation?,
           max_output_tokens: Integer?,
           max_tool_calls: Integer?,

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

@@ -7,6 +7,7 @@ module OpenAI
           call_id: String,
           max_output_length: Integer?,
           output: ::Array[OpenAI::Responses::ResponseFunctionShellToolCallOutput::Output],
+          status: OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput::status,
           type: :shell_call_output,
           created_by: String
         }
@@ -20,6 +21,8 @@ module OpenAI
 
         attr_accessor output: ::Array[OpenAI::Responses::ResponseFunctionShellToolCallOutput::Output]
 
+        attr_accessor status: OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput::status
+
         attr_accessor type: :shell_call_output
 
         attr_reader created_by: String?
@@ -31,6 +34,7 @@ module OpenAI
           call_id: String,
           max_output_length: Integer?,
           output: ::Array[OpenAI::Responses::ResponseFunctionShellToolCallOutput::Output],
+          status: OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput::status,
           ?created_by: String,
           ?type: :shell_call_output
         ) -> void
@@ -40,6 +44,7 @@ module OpenAI
           call_id: String,
           max_output_length: Integer?,
           output: ::Array[OpenAI::Responses::ResponseFunctionShellToolCallOutput::Output],
+          status: OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput::status,
           type: :shell_call_output,
           created_by: String
         }
@@ -109,6 +114,18 @@ module OpenAI
             def self?.variants: -> ::Array[OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput::Output::outcome]
           end
         end
+
+        type status = :in_progress | :completed | :incomplete
+
+        module Status
+          extend OpenAI::Internal::Type::Enum
+
+          IN_PROGRESS: :in_progress
+          COMPLETED: :completed
+          INCOMPLETE: :incomplete
+
+          def self?.values: -> ::Array[OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput::status]
+        end
       end
     end
   end

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

@@ -44,6 +44,7 @@ module OpenAI
             {
               query: String,
               type: :search,
+              queries: ::Array[String],
               sources: ::Array[OpenAI::Responses::ResponseFunctionWebSearch::Action::Search::Source]
             }
 
@@ -52,6 +53,10 @@ module OpenAI
 
             attr_accessor type: :search
 
+            attr_reader queries: ::Array[String]?
+
+            def queries=: (::Array[String]) -> ::Array[String]
+
             attr_reader sources: ::Array[OpenAI::Responses::ResponseFunctionWebSearch::Action::Search::Source]?
 
             def sources=: (
@@ -60,6 +65,7 @@ module OpenAI
 
             def initialize: (
               query: String,
+              ?queries: ::Array[String],
               ?sources: ::Array[OpenAI::Responses::ResponseFunctionWebSearch::Action::Search::Source],
               ?type: :search
             ) -> void
@@ -67,6 +73,7 @@ module OpenAI
             def to_hash: -> {
               query: String,
               type: :search,
+              queries: ::Array[String],
               sources: ::Array[OpenAI::Responses::ResponseFunctionWebSearch::Action::Search::Source]
             }
 
@@ -83,30 +90,39 @@ module OpenAI
             end
           end
 
-          type open_page = { type: :open_page, url: String }
+          type open_page = { type: :open_page, url: String? }
 
           class OpenPage < OpenAI::Internal::Type::BaseModel
             attr_accessor type: :open_page
 
-            attr_accessor url: String
+            attr_accessor url: String?
 
-            def initialize: (url: String, ?type: :open_page) -> void
+            def initialize: (?url: String?, ?type: :open_page) -> void
 
-            def to_hash: -> { type: :open_page, url: String }
+            def to_hash: -> { type: :open_page, url: String? }
           end
 
-          type find = { pattern: String, type: :find, url: String }
+          type find_in_page =
+            { pattern: String, type: :find_in_page, url: String }
 
           class Find < OpenAI::Internal::Type::BaseModel
             attr_accessor pattern: String
 
-            attr_accessor type: :find
+            attr_accessor type: :find_in_page
 
             attr_accessor url: String
 
-            def initialize: (pattern: String, url: String, ?type: :find) -> void
+            def initialize: (
+              pattern: String,
+              url: String,
+              ?type: :find_in_page
+            ) -> void
 
-            def to_hash: -> { pattern: String, type: :find, url: String }
+            def to_hash: -> {
+              pattern: String,
+              type: :find_in_page,
+              url: String
+            }
           end
 
           def self?.variants: -> ::Array[OpenAI::Models::Responses::ResponseFunctionWebSearch::action]