openai 0.50.0 → 0.52.0

data/lib/openai.rb

@@ -363,6 +363,8 @@ require_relative "openai/models/fine_tuning/checkpoints/permission_create_params
 require_relative "openai/models/fine_tuning/checkpoints/permission_create_response"
 require_relative "openai/models/fine_tuning/checkpoints/permission_delete_params"
 require_relative "openai/models/fine_tuning/checkpoints/permission_delete_response"
+require_relative "openai/models/fine_tuning/checkpoints/permission_list_params"
+require_relative "openai/models/fine_tuning/checkpoints/permission_list_response"
 require_relative "openai/models/fine_tuning/checkpoints/permission_retrieve_params"
 require_relative "openai/models/fine_tuning/checkpoints/permission_retrieve_response"
 require_relative "openai/models/fine_tuning/dpo_hyperparameters"
@@ -535,7 +537,10 @@ require_relative "openai/models/response_format_text_grammar"
 require_relative "openai/models/response_format_text_python"
 require_relative "openai/models/responses/apply_patch_tool"
 require_relative "openai/models/responses/compacted_response"
+require_relative "openai/models/responses/computer_action"
+require_relative "openai/models/responses/computer_action_list"
 require_relative "openai/models/responses/computer_tool"
+require_relative "openai/models/responses/computer_use_tool"
 require_relative "openai/models/responses/container_auto"
 require_relative "openai/models/responses/container_network_policy_allowlist"
 require_relative "openai/models/responses/container_network_policy_disabled"
@@ -553,6 +558,7 @@ require_relative "openai/models/responses/input_token_count_params"
 require_relative "openai/models/responses/input_token_count_response"
 require_relative "openai/models/responses/local_environment"
 require_relative "openai/models/responses/local_skill"
+require_relative "openai/models/responses/namespace_tool"
 require_relative "openai/models/responses/response"
 require_relative "openai/models/responses/response_apply_patch_tool_call"
 require_relative "openai/models/responses/response_apply_patch_tool_call_output"
@@ -657,6 +663,9 @@ require_relative "openai/models/responses/response_stream_event"
 require_relative "openai/models/responses/response_text_config"
 require_relative "openai/models/responses/response_text_delta_event"
 require_relative "openai/models/responses/response_text_done_event"
+require_relative "openai/models/responses/response_tool_search_call"
+require_relative "openai/models/responses/response_tool_search_output_item"
+require_relative "openai/models/responses/response_tool_search_output_item_param"
 require_relative "openai/models/responses/response_usage"
 require_relative "openai/models/responses/response_web_search_call_completed_event"
 require_relative "openai/models/responses/response_web_search_call_in_progress_event"
@@ -671,6 +680,7 @@ require_relative "openai/models/responses/tool_choice_mcp"
 require_relative "openai/models/responses/tool_choice_options"
 require_relative "openai/models/responses/tool_choice_shell"
 require_relative "openai/models/responses/tool_choice_types"
+require_relative "openai/models/responses/tool_search_tool"
 require_relative "openai/models/responses/web_search_preview_tool"
 require_relative "openai/models/responses/web_search_tool"
 require_relative "openai/models/responses_model"

data/rbi/openai/client.rbi

@@ -19,27 +19,37 @@ module OpenAI
     sig { returns(T.nilable(String)) }
     attr_reader :project
 
+    # Given a prompt, the model will return one or more predicted completions, and can
+    # also return the probabilities of alternative tokens at each position.
     sig { returns(OpenAI::Resources::Completions) }
     attr_reader :completions
 
     sig { returns(OpenAI::Resources::Chat) }
     attr_reader :chat
 
+    # Get a vector representation of a given input that can be easily consumed by
+    # machine learning models and algorithms.
     sig { returns(OpenAI::Resources::Embeddings) }
     attr_reader :embeddings
 
+    # Files are used to upload documents that can be used with features like
+    # Assistants and Fine-tuning.
     sig { returns(OpenAI::Resources::Files) }
     attr_reader :files
 
+    # Given a prompt and/or an input image, the model will generate a new image.
     sig { returns(OpenAI::Resources::Images) }
     attr_reader :images
 
     sig { returns(OpenAI::Resources::Audio) }
     attr_reader :audio
 
+    # Given text and/or image inputs, classifies if those inputs are potentially
+    # harmful.
     sig { returns(OpenAI::Resources::Moderations) }
     attr_reader :moderations
 
+    # List and describe the various models available in the API.
     sig { returns(OpenAI::Resources::Models) }
     attr_reader :models
 
@@ -58,9 +68,11 @@ module OpenAI
     sig { returns(OpenAI::Resources::Beta) }
     attr_reader :beta
 
+    # Create large batches of API requests to run asynchronously.
     sig { returns(OpenAI::Resources::Batches) }
     attr_reader :batches
 
+    # Use Uploads to upload large files in multiple parts.
     sig { returns(OpenAI::Resources::Uploads) }
     attr_reader :uploads
 
@@ -70,9 +82,11 @@ module OpenAI
     sig { returns(OpenAI::Resources::Realtime) }
     attr_reader :realtime
 
+    # Manage conversations and conversation items.
     sig { returns(OpenAI::Resources::Conversations) }
     attr_reader :conversations
 
+    # Manage and run evals in the OpenAI platform.
     sig { returns(OpenAI::Resources::Evals) }
     attr_reader :evals
 

data/rbi/openai/internal/util.rbi

@@ -301,6 +301,26 @@ module OpenAI
         T.let(%r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)}, Regexp)
 
       class << self
+        # @api private
+        sig do
+          params(query: OpenAI::Internal::AnyHash).returns(
+            OpenAI::Internal::AnyHash
+          )
+        end
+        def encode_query_params(query)
+        end
+
+        # @api private
+        sig do
+          params(
+            collection: OpenAI::Internal::AnyHash,
+            key: String,
+            element: T.anything
+          ).void
+        end
+        private def write_query_param_element!(collection, key, element)
+        end
+
         # @api private
         sig do
           params(

data/rbi/openai/models/batch_cancel_params.rbi

@@ -11,15 +11,23 @@ module OpenAI
           T.any(OpenAI::BatchCancelParams, OpenAI::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :batch_id
+
       sig do
-        params(request_options: OpenAI::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          batch_id: String,
+          request_options: OpenAI::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(batch_id:, request_options: {})
       end
 
-      sig { override.returns({ request_options: OpenAI::RequestOptions }) }
+      sig do
+        override.returns(
+          { batch_id: String, request_options: OpenAI::RequestOptions }
+        )
+      end
       def to_hash
       end
     end

data/rbi/openai/models/batch_retrieve_params.rbi

@@ -11,15 +11,23 @@ module OpenAI
           T.any(OpenAI::BatchRetrieveParams, OpenAI::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :batch_id
+
       sig do
-        params(request_options: OpenAI::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          batch_id: String,
+          request_options: OpenAI::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(batch_id:, request_options: {})
       end
 
-      sig { override.returns({ request_options: OpenAI::RequestOptions }) }
+      sig do
+        override.returns(
+          { batch_id: String, request_options: OpenAI::RequestOptions }
+        )
+      end
       def to_hash
       end
     end

data/rbi/openai/models/beta/assistant_create_params.rbi

@@ -549,8 +549,9 @@ module OpenAI
               attr_writer :chunking_strategy
 
               # A list of [file](https://platform.openai.com/docs/api-reference/files) IDs to
-              # add to the vector store. There can be a maximum of 10000 files in a vector
-              # store.
+              # add to the vector store. For vector stores created before Nov 2025, there can be
+              # a maximum of 10,000 files in a vector store. For vector stores created starting
+              # in Nov 2025, the limit is 100,000,000 files.
               sig { returns(T.nilable(T::Array[String])) }
               attr_reader :file_ids
 
@@ -582,8 +583,9 @@ module OpenAI
                 # strategy.
                 chunking_strategy: nil,
                 # A list of [file](https://platform.openai.com/docs/api-reference/files) IDs to
-                # add to the vector store. There can be a maximum of 10000 files in a vector
-                # store.
+                # add to the vector store. For vector stores created before Nov 2025, there can be
+                # a maximum of 10,000 files in a vector store. For vector stores created starting
+                # in Nov 2025, the limit is 100,000,000 files.
                 file_ids: nil,
                 # Set of 16 key-value pairs that can be attached to an object. This can be useful
                 # for storing additional information about the object in a structured format, and

data/rbi/openai/models/beta/assistant_delete_params.rbi

@@ -15,15 +15,23 @@ module OpenAI
             )
           end
 
+        sig { returns(String) }
+        attr_accessor :assistant_id
+
         sig do
-          params(request_options: OpenAI::RequestOptions::OrHash).returns(
-            T.attached_class
-          )
+          params(
+            assistant_id: String,
+            request_options: OpenAI::RequestOptions::OrHash
+          ).returns(T.attached_class)
         end
-        def self.new(request_options: {})
+        def self.new(assistant_id:, request_options: {})
         end
 
-        sig { override.returns({ request_options: OpenAI::RequestOptions }) }
+        sig do
+          override.returns(
+            { assistant_id: String, request_options: OpenAI::RequestOptions }
+          )
+        end
         def to_hash
         end
       end

data/rbi/openai/models/beta/assistant_retrieve_params.rbi

@@ -15,15 +15,23 @@ module OpenAI
             )
           end
 
+        sig { returns(String) }
+        attr_accessor :assistant_id
+
         sig do
-          params(request_options: OpenAI::RequestOptions::OrHash).returns(
-            T.attached_class
-          )
+          params(
+            assistant_id: String,
+            request_options: OpenAI::RequestOptions::OrHash
+          ).returns(T.attached_class)
         end
-        def self.new(request_options: {})
+        def self.new(assistant_id:, request_options: {})
         end
 
-        sig { override.returns({ request_options: OpenAI::RequestOptions }) }
+        sig do
+          override.returns(
+            { assistant_id: String, request_options: OpenAI::RequestOptions }
+          )
+        end
         def to_hash
         end
       end

data/rbi/openai/models/beta/assistant_update_params.rbi

@@ -15,6 +15,9 @@ module OpenAI
             )
           end
 
+        sig { returns(String) }
+        attr_accessor :assistant_id
+
         # The description of the assistant. The maximum length is 512 characters.
         sig { returns(T.nilable(String)) }
         attr_accessor :description
@@ -182,6 +185,7 @@ module OpenAI
 
         sig do
           params(
+            assistant_id: String,
             description: T.nilable(String),
             instructions: T.nilable(String),
             metadata: T.nilable(T::Hash[Symbol, String]),
@@ -219,6 +223,7 @@ module OpenAI
           ).returns(T.attached_class)
         end
         def self.new(
+          assistant_id:,
           # The description of the assistant. The maximum length is 512 characters.
           description: nil,
           # The system instructions that the assistant uses. The maximum length is 256,000
@@ -300,6 +305,7 @@ module OpenAI
         sig do
           override.returns(
             {
+              assistant_id: String,
               description: T.nilable(String),
               instructions: T.nilable(String),
               metadata: T.nilable(T::Hash[Symbol, String]),

data/rbi/openai/models/beta/chatkit/session_cancel_params.rbi

@@ -16,15 +16,23 @@ module OpenAI
               )
             end
 
+          sig { returns(String) }
+          attr_accessor :session_id
+
           sig do
-            params(request_options: OpenAI::RequestOptions::OrHash).returns(
-              T.attached_class
-            )
+            params(
+              session_id: String,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(T.attached_class)
           end
-          def self.new(request_options: {})
+          def self.new(session_id:, request_options: {})
           end
 
-          sig { override.returns({ request_options: OpenAI::RequestOptions }) }
+          sig do
+            override.returns(
+              { session_id: String, request_options: OpenAI::RequestOptions }
+            )
+          end
           def to_hash
           end
         end

data/rbi/openai/models/beta/chatkit/thread_delete_params.rbi

@@ -16,15 +16,23 @@ module OpenAI
               )
             end
 
+          sig { returns(String) }
+          attr_accessor :thread_id
+
           sig do
-            params(request_options: OpenAI::RequestOptions::OrHash).returns(
-              T.attached_class
-            )
+            params(
+              thread_id: String,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(T.attached_class)
           end
-          def self.new(request_options: {})
+          def self.new(thread_id:, request_options: {})
           end
 
-          sig { override.returns({ request_options: OpenAI::RequestOptions }) }
+          sig do
+            override.returns(
+              { thread_id: String, request_options: OpenAI::RequestOptions }
+            )
+          end
           def to_hash
           end
         end

data/rbi/openai/models/beta/chatkit/thread_list_items_params.rbi

@@ -16,6 +16,9 @@ module OpenAI
               )
             end
 
+          sig { returns(String) }
+          attr_accessor :thread_id
+
           # List items created after this thread item ID. Defaults to null for the first
           # page.
           sig { returns(T.nilable(String)) }
@@ -59,6 +62,7 @@ module OpenAI
 
           sig do
             params(
+              thread_id: String,
               after: String,
               before: String,
               limit: Integer,
@@ -68,6 +72,7 @@ module OpenAI
             ).returns(T.attached_class)
           end
           def self.new(
+            thread_id:,
             # List items created after this thread item ID. Defaults to null for the first
             # page.
             after: nil,
@@ -85,6 +90,7 @@ module OpenAI
           sig do
             override.returns(
               {
+                thread_id: String,
                 after: String,
                 before: String,
                 limit: Integer,

data/rbi/openai/models/beta/chatkit/thread_retrieve_params.rbi

@@ -16,15 +16,23 @@ module OpenAI
               )
             end
 
+          sig { returns(String) }
+          attr_accessor :thread_id
+
           sig do
-            params(request_options: OpenAI::RequestOptions::OrHash).returns(
-              T.attached_class
-            )
+            params(
+              thread_id: String,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(T.attached_class)
           end
-          def self.new(request_options: {})
+          def self.new(thread_id:, request_options: {})
           end
 
-          sig { override.returns({ request_options: OpenAI::RequestOptions }) }
+          sig do
+            override.returns(
+              { thread_id: String, request_options: OpenAI::RequestOptions }
+            )
+          end
           def to_hash
           end
         end

data/rbi/openai/models/beta/thread_create_and_run_params.rbi

@@ -1070,8 +1070,9 @@ module OpenAI
                 attr_writer :chunking_strategy
 
                 # A list of [file](https://platform.openai.com/docs/api-reference/files) IDs to
-                # add to the vector store. There can be a maximum of 10000 files in a vector
-                # store.
+                # add to the vector store. For vector stores created before Nov 2025, there can be
+                # a maximum of 10,000 files in a vector store. For vector stores created starting
+                # in Nov 2025, the limit is 100,000,000 files.
                 sig { returns(T.nilable(T::Array[String])) }
                 attr_reader :file_ids
 
@@ -1103,8 +1104,9 @@ module OpenAI
                   # strategy.
                   chunking_strategy: nil,
                   # A list of [file](https://platform.openai.com/docs/api-reference/files) IDs to
-                  # add to the vector store. There can be a maximum of 10000 files in a vector
-                  # store.
+                  # add to the vector store. For vector stores created before Nov 2025, there can be
+                  # a maximum of 10,000 files in a vector store. For vector stores created starting
+                  # in Nov 2025, the limit is 100,000,000 files.
                   file_ids: nil,
                   # Set of 16 key-value pairs that can be attached to an object. This can be useful
                   # for storing additional information about the object in a structured format, and

data/rbi/openai/models/beta/thread_create_params.rbi

@@ -622,8 +622,9 @@ module OpenAI
               attr_writer :chunking_strategy
 
               # A list of [file](https://platform.openai.com/docs/api-reference/files) IDs to
-              # add to the vector store. There can be a maximum of 10000 files in a vector
-              # store.
+              # add to the vector store. For vector stores created before Nov 2025, there can be
+              # a maximum of 10,000 files in a vector store. For vector stores created starting
+              # in Nov 2025, the limit is 100,000,000 files.
               sig { returns(T.nilable(T::Array[String])) }
               attr_reader :file_ids
 
@@ -655,8 +656,9 @@ module OpenAI
                 # strategy.
                 chunking_strategy: nil,
                 # A list of [file](https://platform.openai.com/docs/api-reference/files) IDs to
-                # add to the vector store. There can be a maximum of 10000 files in a vector
-                # store.
+                # add to the vector store. For vector stores created before Nov 2025, there can be
+                # a maximum of 10,000 files in a vector store. For vector stores created starting
+                # in Nov 2025, the limit is 100,000,000 files.
                 file_ids: nil,
                 # Set of 16 key-value pairs that can be attached to an object. This can be useful
                 # for storing additional information about the object in a structured format, and

data/rbi/openai/models/beta/thread_delete_params.rbi

@@ -12,15 +12,23 @@ module OpenAI
             T.any(OpenAI::Beta::ThreadDeleteParams, OpenAI::Internal::AnyHash)
           end
 
+        sig { returns(String) }
+        attr_accessor :thread_id
+
         sig do
-          params(request_options: OpenAI::RequestOptions::OrHash).returns(
-            T.attached_class
-          )
+          params(
+            thread_id: String,
+            request_options: OpenAI::RequestOptions::OrHash
+          ).returns(T.attached_class)
         end
-        def self.new(request_options: {})
+        def self.new(thread_id:, request_options: {})
         end
 
-        sig { override.returns({ request_options: OpenAI::RequestOptions }) }
+        sig do
+          override.returns(
+            { thread_id: String, request_options: OpenAI::RequestOptions }
+          )
+        end
         def to_hash
         end
       end

data/rbi/openai/models/beta/thread_retrieve_params.rbi

@@ -12,15 +12,23 @@ module OpenAI
             T.any(OpenAI::Beta::ThreadRetrieveParams, OpenAI::Internal::AnyHash)
           end
 
+        sig { returns(String) }
+        attr_accessor :thread_id
+
         sig do
-          params(request_options: OpenAI::RequestOptions::OrHash).returns(
-            T.attached_class
-          )
+          params(
+            thread_id: String,
+            request_options: OpenAI::RequestOptions::OrHash
+          ).returns(T.attached_class)
         end
-        def self.new(request_options: {})
+        def self.new(thread_id:, request_options: {})
         end
 
-        sig { override.returns({ request_options: OpenAI::RequestOptions }) }
+        sig do
+          override.returns(
+            { thread_id: String, request_options: OpenAI::RequestOptions }
+          )
+        end
         def to_hash
         end
       end

data/rbi/openai/models/beta/thread_update_params.rbi

@@ -12,6 +12,9 @@ module OpenAI
             T.any(OpenAI::Beta::ThreadUpdateParams, OpenAI::Internal::AnyHash)
           end
 
+        sig { returns(String) }
+        attr_accessor :thread_id
+
         # Set of 16 key-value pairs that can be attached to an object. This can be useful
         # for storing additional information about the object in a structured format, and
         # querying for objects via API or the dashboard.
@@ -40,6 +43,7 @@ module OpenAI
 
         sig do
           params(
+            thread_id: String,
             metadata: T.nilable(T::Hash[Symbol, String]),
             tool_resources:
               T.nilable(
@@ -49,6 +53,7 @@ module OpenAI
           ).returns(T.attached_class)
         end
         def self.new(
+          thread_id:,
           # Set of 16 key-value pairs that can be attached to an object. This can be useful
           # for storing additional information about the object in a structured format, and
           # querying for objects via API or the dashboard.
@@ -68,6 +73,7 @@ module OpenAI
         sig do
           override.returns(
             {
+              thread_id: String,
               metadata: T.nilable(T::Hash[Symbol, String]),
               tool_resources:
                 T.nilable(OpenAI::Beta::ThreadUpdateParams::ToolResources),

data/rbi/openai/models/beta/threads/message_create_params.rbi

@@ -16,6 +16,9 @@ module OpenAI
               )
             end
 
+          sig { returns(String) }
+          attr_accessor :thread_id
+
           # The text contents of the message.
           sig do
             returns(
@@ -56,6 +59,7 @@ module OpenAI
 
           sig do
             params(
+              thread_id: String,
               content:
                 OpenAI::Beta::Threads::MessageCreateParams::Content::Variants,
               role: OpenAI::Beta::Threads::MessageCreateParams::Role::OrSymbol,
@@ -70,6 +74,7 @@ module OpenAI
             ).returns(T.attached_class)
           end
           def self.new(
+            thread_id:,
             # The text contents of the message.
             content:,
             # The role of the entity that is creating the message. Allowed values include:
@@ -95,6 +100,7 @@ module OpenAI
           sig do
             override.returns(
               {
+                thread_id: String,
                 content:
                   OpenAI::Beta::Threads::MessageCreateParams::Content::Variants,
                 role:

data/rbi/openai/models/beta/threads/message_delete_params.rbi

@@ -19,18 +19,26 @@ module OpenAI
           sig { returns(String) }
           attr_accessor :thread_id
 
+          sig { returns(String) }
+          attr_accessor :message_id
+
           sig do
             params(
               thread_id: String,
+              message_id: String,
               request_options: OpenAI::RequestOptions::OrHash
             ).returns(T.attached_class)
           end
-          def self.new(thread_id:, request_options: {})
+          def self.new(thread_id:, message_id:, request_options: {})
           end
 
           sig do
             override.returns(
-              { thread_id: String, request_options: OpenAI::RequestOptions }
+              {
+                thread_id: String,
+                message_id: String,
+                request_options: OpenAI::RequestOptions
+              }
             )
           end
           def to_hash