openai 0.43.0 → 0.45.0

data/rbi/openai/models/file_create_params.rbi

@@ -15,10 +15,14 @@ module OpenAI
       sig { returns(OpenAI::Internal::FileInput) }
       attr_accessor :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
       sig { returns(OpenAI::FilePurpose::OrSymbol) }
       attr_accessor :purpose
 
@@ -45,10 +49,14 @@ module OpenAI
       def self.new(
         # 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/models/file_purpose.rbi

@@ -2,10 +2,14 @@
 
 module OpenAI
   module Models
-    # 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
     module FilePurpose
       extend OpenAI::Internal::Type::Enum
 

data/rbi/openai/models/realtime/conversation_item_create_event.rbi

@@ -42,10 +42,14 @@ module OpenAI
         attr_writer :event_id
 
         # The ID of the preceding item after which the new item will be inserted. If not
-        # set, the new item will be appended to the end of the conversation. If set to
-        # `root`, the new item will be added to the beginning of the conversation. If set
-        # to an existing ID, it allows an item to be inserted mid-conversation. If the ID
-        # cannot be found, an error will be returned and the item will not be added.
+        # set, the new item will be appended to the end of the conversation.
+        #
+        # If set to `root`, the new item will be added to the beginning of the
+        # conversation.
+        #
+        # If set to an existing ID, it allows an item to be inserted mid-conversation. If
+        # the ID cannot be found, an error will be returned and the item will not be
+        # added.
         sig { returns(T.nilable(String)) }
         attr_reader :previous_item_id
 
@@ -84,10 +88,14 @@ module OpenAI
           # Optional client-generated ID used to identify this event.
           event_id: nil,
           # The ID of the preceding item after which the new item will be inserted. If not
-          # set, the new item will be appended to the end of the conversation. If set to
-          # `root`, the new item will be added to the beginning of the conversation. If set
-          # to an existing ID, it allows an item to be inserted mid-conversation. If the ID
-          # cannot be found, an error will be returned and the item will not be added.
+          # set, the new item will be appended to the end of the conversation.
+          #
+          # If set to `root`, the new item will be added to the beginning of the
+          # conversation.
+          #
+          # If set to an existing ID, it allows an item to be inserted mid-conversation. If
+          # the ID cannot be found, an error will be returned and the item will not be
+          # added.
           previous_item_id: nil,
           # The event type, must be `conversation.item.create`.
           type: :"conversation.item.create"

data/rbi/openai/models/realtime/response_function_call_arguments_done_event.rbi

@@ -28,6 +28,10 @@ module OpenAI
         sig { returns(String) }
         attr_accessor :item_id
 
+        # The name of the function that was called.
+        sig { returns(String) }
+        attr_accessor :name
+
         # The index of the output item in the response.
         sig { returns(Integer) }
         attr_accessor :output_index
@@ -48,6 +52,7 @@ module OpenAI
             call_id: String,
             event_id: String,
             item_id: String,
+            name: String,
             output_index: Integer,
             response_id: String,
             type: Symbol
@@ -62,6 +67,8 @@ module OpenAI
           event_id:,
           # The ID of the function call item.
           item_id:,
+          # The name of the function that was called.
+          name:,
           # The index of the output item in the response.
           output_index:,
           # The ID of the response.
@@ -78,6 +85,7 @@ module OpenAI
               call_id: String,
               event_id: String,
               item_id: String,
+              name: String,
               output_index: Integer,
               response_id: String,
               type: Symbol

data/rbi/openai/models/responses/response_function_shell_tool_call_output.rbi

@@ -36,6 +36,15 @@ module OpenAI
         end
         attr_accessor :output
 
+        # The status of the shell call output. One of `in_progress`, `completed`, or
+        # `incomplete`.
+        sig do
+          returns(
+            OpenAI::Responses::ResponseFunctionShellToolCallOutput::Status::TaggedSymbol
+          )
+        end
+        attr_accessor :status
+
         # The type of the shell call output. Always `shell_call_output`.
         sig { returns(Symbol) }
         attr_accessor :type
@@ -57,6 +66,8 @@ module OpenAI
               T::Array[
                 OpenAI::Responses::ResponseFunctionShellToolCallOutput::Output::OrHash
               ],
+            status:
+              OpenAI::Responses::ResponseFunctionShellToolCallOutput::Status::OrSymbol,
             created_by: String,
             type: Symbol
           ).returns(T.attached_class)
@@ -72,6 +83,9 @@ module OpenAI
           max_output_length:,
           # An array of shell call output contents
           output:,
+          # The status of the shell call output. One of `in_progress`, `completed`, or
+          # `incomplete`.
+          status:,
           # The identifier of the actor that created the item.
           created_by: nil,
           # The type of the shell call output. Always `shell_call_output`.
@@ -89,6 +103,8 @@ module OpenAI
                 T::Array[
                   OpenAI::Responses::ResponseFunctionShellToolCallOutput::Output
                 ],
+              status:
+                OpenAI::Responses::ResponseFunctionShellToolCallOutput::Status::TaggedSymbol,
               type: Symbol,
               created_by: String
             }
@@ -256,6 +272,47 @@ module OpenAI
             end
           end
         end
+
+        # The status of the shell call output. One of `in_progress`, `completed`, or
+        # `incomplete`.
+        module Status
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                OpenAI::Responses::ResponseFunctionShellToolCallOutput::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          IN_PROGRESS =
+            T.let(
+              :in_progress,
+              OpenAI::Responses::ResponseFunctionShellToolCallOutput::Status::TaggedSymbol
+            )
+          COMPLETED =
+            T.let(
+              :completed,
+              OpenAI::Responses::ResponseFunctionShellToolCallOutput::Status::TaggedSymbol
+            )
+          INCOMPLETE =
+            T.let(
+              :incomplete,
+              OpenAI::Responses::ResponseFunctionShellToolCallOutput::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Responses::ResponseFunctionShellToolCallOutput::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
       end
     end
   end

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
 
@@ -239,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
@@ -278,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
@@ -290,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/tool.rbi

@@ -836,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
@@ -1003,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:
@@ -1029,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,
@@ -1067,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:
@@ -1095,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
@@ -1255,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/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/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_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

@@ -90,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]