openai 0.51.0 → 0.53.0

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

@@ -3,6 +3,7 @@
 module OpenAI
   module Resources
     class Audio
+      # Turn audio into text or text into audio.
       class Speech
         # Generates audio from the input text.
         #

data/rbi/openai/resources/audio/transcriptions.rbi

@@ -3,6 +3,7 @@
 module OpenAI
   module Resources
     class Audio
+      # Turn audio into text or text into audio.
       class Transcriptions
         # See {OpenAI::Resources::Audio::Transcriptions#create_streaming} for streaming
         # counterpart.

data/rbi/openai/resources/audio/translations.rbi

@@ -3,6 +3,7 @@
 module OpenAI
   module Resources
     class Audio
+      # Turn audio into text or text into audio.
       class Translations
         # Translates audio into English.
         sig do

data/rbi/openai/resources/audio.rbi

@@ -3,12 +3,15 @@
 module OpenAI
   module Resources
     class Audio
+      # Turn audio into text or text into audio.
       sig { returns(OpenAI::Resources::Audio::Transcriptions) }
       attr_reader :transcriptions
 
+      # Turn audio into text or text into audio.
       sig { returns(OpenAI::Resources::Audio::Translations) }
       attr_reader :translations
 
+      # Turn audio into text or text into audio.
       sig { returns(OpenAI::Resources::Audio::Speech) }
       attr_reader :speech
 

data/rbi/openai/resources/batches.rbi

@@ -2,6 +2,7 @@
 
 module OpenAI
   module Resources
+    # Create large batches of API requests to run asynchronously.
     class Batches
       # Creates and executes a batch from an uploaded file of requests
       sig do

data/rbi/openai/resources/beta/assistants.rbi

@@ -3,6 +3,7 @@
 module OpenAI
   module Resources
     class Beta
+      # Build Assistants that can call models and use tools.
       class Assistants
         # Create an assistant with a model and instructions.
         sig do

data/rbi/openai/resources/beta/threads/messages.rbi

@@ -4,6 +4,7 @@ module OpenAI
   module Resources
     class Beta
       class Threads
+        # Build Assistants that can call models and use tools.
         class Messages
           # Create a message.
           sig do

data/rbi/openai/resources/beta/threads/runs/steps.rbi

@@ -5,6 +5,7 @@ module OpenAI
     class Beta
       class Threads
         class Runs
+          # Build Assistants that can call models and use tools.
           class Steps
             # Retrieves a run step.
             sig do

data/rbi/openai/resources/beta/threads/runs.rbi

@@ -4,7 +4,9 @@ module OpenAI
   module Resources
     class Beta
       class Threads
+        # Build Assistants that can call models and use tools.
         class Runs
+          # Build Assistants that can call models and use tools.
           sig { returns(OpenAI::Resources::Beta::Threads::Runs::Steps) }
           attr_reader :steps
 

data/rbi/openai/resources/beta/threads.rbi

@@ -3,10 +3,13 @@
 module OpenAI
   module Resources
     class Beta
+      # Build Assistants that can call models and use tools.
       class Threads
+        # Build Assistants that can call models and use tools.
         sig { returns(OpenAI::Resources::Beta::Threads::Runs) }
         attr_reader :runs
 
+        # Build Assistants that can call models and use tools.
         sig { returns(OpenAI::Resources::Beta::Threads::Messages) }
         attr_reader :messages
 

data/rbi/openai/resources/beta.rbi

@@ -6,9 +6,11 @@ module OpenAI
       sig { returns(OpenAI::Resources::Beta::ChatKit) }
       attr_reader :chatkit
 
+      # Build Assistants that can call models and use tools.
       sig { returns(OpenAI::Resources::Beta::Assistants) }
       attr_reader :assistants
 
+      # Build Assistants that can call models and use tools.
       sig { returns(OpenAI::Resources::Beta::Threads) }
       attr_reader :threads
 

data/rbi/openai/resources/chat/completions/messages.rbi

@@ -4,6 +4,8 @@ module OpenAI
   module Resources
     class Chat
       class Completions
+        # Given a list of messages comprising a conversation, the model will return a
+        # response.
         class Messages
           # Get the messages in a stored chat completion. Only Chat Completions that have
           # been created with the `store` parameter set to `true` will be returned.

data/rbi/openai/resources/chat/completions.rbi

@@ -3,7 +3,11 @@
 module OpenAI
   module Resources
     class Chat
+      # Given a list of messages comprising a conversation, the model will return a
+      # response.
       class Completions
+        # Given a list of messages comprising a conversation, the model will return a
+        # response.
         sig { returns(OpenAI::Resources::Chat::Completions::Messages) }
         attr_reader :messages
 

data/rbi/openai/resources/chat.rbi

@@ -3,6 +3,8 @@
 module OpenAI
   module Resources
     class Chat
+      # Given a list of messages comprising a conversation, the model will return a
+      # response.
       sig { returns(OpenAI::Resources::Chat::Completions) }
       attr_reader :completions
 

data/rbi/openai/resources/completions.rbi

@@ -2,6 +2,8 @@
 
 module OpenAI
   module Resources
+    # Given a prompt, the model will return one or more predicted completions, and can
+    # also return the probabilities of alternative tokens at each position.
     class Completions
       # See {OpenAI::Resources::Completions#create_streaming} for streaming counterpart.
       #

data/rbi/openai/resources/conversations/items.rbi

@@ -3,6 +3,7 @@
 module OpenAI
   module Resources
     class Conversations
+      # Manage conversations and conversation items.
       class Items
         # Create items in a conversation with the given ID.
         sig do
@@ -20,6 +21,8 @@ module OpenAI
                   OpenAI::Responses::ResponseFunctionWebSearch::OrHash,
                   OpenAI::Responses::ResponseFunctionToolCall::OrHash,
                   OpenAI::Responses::ResponseInputItem::FunctionCallOutput::OrHash,
+                  OpenAI::Responses::ResponseInputItem::ToolSearchCall::OrHash,
+                  OpenAI::Responses::ResponseToolSearchOutputItemParam::OrHash,
                   OpenAI::Responses::ResponseReasoningItem::OrHash,
                   OpenAI::Responses::ResponseCompactionItemParam::OrHash,
                   OpenAI::Responses::ResponseInputItem::ImageGenerationCall::OrHash,

data/rbi/openai/resources/conversations.rbi

@@ -2,7 +2,9 @@
 
 module OpenAI
   module Resources
+    # Manage conversations and conversation items.
     class Conversations
+      # Manage conversations and conversation items.
       sig { returns(OpenAI::Resources::Conversations::Items) }
       attr_reader :items
 
@@ -22,6 +24,8 @@ module OpenAI
                   OpenAI::Responses::ResponseFunctionWebSearch::OrHash,
                   OpenAI::Responses::ResponseFunctionToolCall::OrHash,
                   OpenAI::Responses::ResponseInputItem::FunctionCallOutput::OrHash,
+                  OpenAI::Responses::ResponseInputItem::ToolSearchCall::OrHash,
+                  OpenAI::Responses::ResponseToolSearchOutputItemParam::OrHash,
                   OpenAI::Responses::ResponseReasoningItem::OrHash,
                   OpenAI::Responses::ResponseCompactionItemParam::OrHash,
                   OpenAI::Responses::ResponseInputItem::ImageGenerationCall::OrHash,

data/rbi/openai/resources/embeddings.rbi

@@ -2,6 +2,8 @@
 
 module OpenAI
   module Resources
+    # Get a vector representation of a given input that can be easily consumed by
+    # machine learning models and algorithms.
     class Embeddings
       # Creates an embedding vector representing the input text.
       sig do

data/rbi/openai/resources/evals/runs/output_items.rbi

@@ -4,6 +4,7 @@ module OpenAI
   module Resources
     class Evals
       class Runs
+        # Manage and run evals in the OpenAI platform.
         class OutputItems
           # Get an evaluation run output item by ID.
           sig do

data/rbi/openai/resources/evals/runs.rbi

@@ -3,7 +3,9 @@
 module OpenAI
   module Resources
     class Evals
+      # Manage and run evals in the OpenAI platform.
       class Runs
+        # Manage and run evals in the OpenAI platform.
         sig { returns(OpenAI::Resources::Evals::Runs::OutputItems) }
         attr_reader :output_items
 

data/rbi/openai/resources/evals.rbi

@@ -2,7 +2,9 @@
 
 module OpenAI
   module Resources
+    # Manage and run evals in the OpenAI platform.
     class Evals
+      # Manage and run evals in the OpenAI platform.
       sig { returns(OpenAI::Resources::Evals::Runs) }
       attr_reader :runs
 

data/rbi/openai/resources/files.rbi

@@ -2,6 +2,8 @@
 
 module OpenAI
   module Resources
+    # Files are used to upload documents that can be used with features like
+    # Assistants and Fine-tuning.
     class Files
       # Upload a file that can be used across various endpoints. Individual files can be
       # up to 512 MB, and each project can store up to 2.5 TB of files in total. There

data/rbi/openai/resources/fine_tuning/alpha/graders.rbi

@@ -4,6 +4,7 @@ module OpenAI
   module Resources
     class FineTuning
       class Alpha
+        # Manage fine-tuning jobs to tailor a model to your specific training data.
         class Graders
           # Run a grader.
           sig do

data/rbi/openai/resources/fine_tuning/alpha.rbi

@@ -4,6 +4,7 @@ module OpenAI
   module Resources
     class FineTuning
       class Alpha
+        # Manage fine-tuning jobs to tailor a model to your specific training data.
         sig { returns(OpenAI::Resources::FineTuning::Alpha::Graders) }
         attr_reader :graders
 

data/rbi/openai/resources/fine_tuning/checkpoints/permissions.rbi

@@ -4,6 +4,7 @@ module OpenAI
   module Resources
     class FineTuning
       class Checkpoints
+        # Manage fine-tuning jobs to tailor a model to your specific training data.
         class Permissions
           # **NOTE:** Calling this endpoint requires an [admin API key](../admin-api-keys).
           #
@@ -61,6 +62,40 @@ module OpenAI
           )
           end
 
+          # **NOTE:** This endpoint requires an [admin API key](../admin-api-keys).
+          #
+          # Organization owners can use this endpoint to view all permissions for a
+          # fine-tuned model checkpoint.
+          sig do
+            params(
+              fine_tuned_model_checkpoint: String,
+              after: String,
+              limit: Integer,
+              order:
+                OpenAI::FineTuning::Checkpoints::PermissionListParams::Order::OrSymbol,
+              project_id: String,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(
+              OpenAI::Internal::ConversationCursorPage[
+                OpenAI::Models::FineTuning::Checkpoints::PermissionListResponse
+              ]
+            )
+          end
+          def list(
+            # The ID of the fine-tuned model checkpoint to get permissions for.
+            fine_tuned_model_checkpoint,
+            # Identifier for the last permission ID from the previous pagination request.
+            after: nil,
+            # Number of permissions to retrieve.
+            limit: nil,
+            # The order in which to retrieve permissions.
+            order: nil,
+            # The ID of the project to get permissions for.
+            project_id: nil,
+            request_options: {}
+          )
+          end
+
           # **NOTE:** This endpoint requires an [admin API key](../admin-api-keys).
           #
           # Organization owners can use this endpoint to delete a permission for a

data/rbi/openai/resources/fine_tuning/checkpoints.rbi

@@ -4,6 +4,7 @@ module OpenAI
   module Resources
     class FineTuning
       class Checkpoints
+        # Manage fine-tuning jobs to tailor a model to your specific training data.
         sig { returns(OpenAI::Resources::FineTuning::Checkpoints::Permissions) }
         attr_reader :permissions
 

data/rbi/openai/resources/fine_tuning/jobs/checkpoints.rbi

@@ -4,6 +4,7 @@ module OpenAI
   module Resources
     class FineTuning
       class Jobs
+        # Manage fine-tuning jobs to tailor a model to your specific training data.
         class Checkpoints
           # List checkpoints for a fine-tuning job.
           sig do

data/rbi/openai/resources/fine_tuning/jobs.rbi

@@ -3,7 +3,9 @@
 module OpenAI
   module Resources
     class FineTuning
+      # Manage fine-tuning jobs to tailor a model to your specific training data.
       class Jobs
+        # Manage fine-tuning jobs to tailor a model to your specific training data.
         sig { returns(OpenAI::Resources::FineTuning::Jobs::Checkpoints) }
         attr_reader :checkpoints
 

data/rbi/openai/resources/fine_tuning.rbi

@@ -6,6 +6,7 @@ module OpenAI
       sig { returns(OpenAI::Resources::FineTuning::Methods) }
       attr_reader :methods_
 
+      # Manage fine-tuning jobs to tailor a model to your specific training data.
       sig { returns(OpenAI::Resources::FineTuning::Jobs) }
       attr_reader :jobs
 

data/rbi/openai/resources/images.rbi

@@ -2,6 +2,7 @@
 
 module OpenAI
   module Resources
+    # Given a prompt and/or an input image, the model will generate a new image.
     class Images
       # Creates a variation of a given image. This endpoint only supports `dall-e-2`.
       sig do

data/rbi/openai/resources/models.rbi

@@ -2,6 +2,7 @@
 
 module OpenAI
   module Resources
+    # List and describe the various models available in the API.
     class Models
       # Retrieves a model instance, providing basic information about the model such as
       # the owner and permissioning.

data/rbi/openai/resources/moderations.rbi

@@ -2,6 +2,8 @@
 
 module OpenAI
   module Resources
+    # Given text and/or image inputs, classifies if those inputs are potentially
+    # harmful.
     class Moderations
       # Classifies if text and/or image inputs are potentially harmful. Learn more in
       # the [moderation guide](https://platform.openai.com/docs/guides/moderation).

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

@@ -48,12 +48,15 @@ module OpenAI
                     OpenAI::Responses::FunctionTool::OrHash,
                     OpenAI::Responses::FileSearchTool::OrHash,
                     OpenAI::Responses::ComputerTool::OrHash,
+                    OpenAI::Responses::ComputerUsePreviewTool::OrHash,
                     OpenAI::Responses::Tool::Mcp::OrHash,
                     OpenAI::Responses::Tool::CodeInterpreter::OrHash,
                     OpenAI::Responses::Tool::ImageGeneration::OrHash,
                     OpenAI::Responses::Tool::LocalShell::OrHash,
                     OpenAI::Responses::FunctionShellTool::OrHash,
                     OpenAI::Responses::CustomTool::OrHash,
+                    OpenAI::Responses::NamespaceTool::OrHash,
+                    OpenAI::Responses::ToolSearchTool::OrHash,
                     OpenAI::Responses::ApplyPatchTool::OrHash,
                     OpenAI::Responses::WebSearchTool::OrHash,
                     OpenAI::Responses::WebSearchPreviewTool::OrHash

data/rbi/openai/resources/responses.rbi

@@ -95,12 +95,15 @@ module OpenAI
                 OpenAI::Responses::FunctionTool::OrHash,
                 OpenAI::Responses::FileSearchTool::OrHash,
                 OpenAI::Responses::ComputerTool::OrHash,
+                OpenAI::Responses::ComputerUsePreviewTool::OrHash,
                 OpenAI::Responses::Tool::Mcp::OrHash,
                 OpenAI::Responses::Tool::CodeInterpreter::OrHash,
                 OpenAI::Responses::Tool::ImageGeneration::OrHash,
                 OpenAI::Responses::Tool::LocalShell::OrHash,
                 OpenAI::Responses::FunctionShellTool::OrHash,
                 OpenAI::Responses::CustomTool::OrHash,
+                OpenAI::Responses::NamespaceTool::OrHash,
+                OpenAI::Responses::ToolSearchTool::OrHash,
                 OpenAI::Responses::ApplyPatchTool::OrHash,
                 OpenAI::Responses::WebSearchTool::OrHash,
                 OpenAI::Responses::WebSearchPreviewTool::OrHash
@@ -390,12 +393,15 @@ module OpenAI
                 OpenAI::Responses::FunctionTool::OrHash,
                 OpenAI::Responses::FileSearchTool::OrHash,
                 OpenAI::Responses::ComputerTool::OrHash,
+                OpenAI::Responses::ComputerUsePreviewTool::OrHash,
                 OpenAI::Responses::Tool::Mcp::OrHash,
                 OpenAI::Responses::Tool::CodeInterpreter::OrHash,
                 OpenAI::Responses::Tool::ImageGeneration::OrHash,
                 OpenAI::Responses::Tool::LocalShell::OrHash,
                 OpenAI::Responses::FunctionShellTool::OrHash,
                 OpenAI::Responses::CustomTool::OrHash,
+                OpenAI::Responses::NamespaceTool::OrHash,
+                OpenAI::Responses::ToolSearchTool::OrHash,
                 OpenAI::Responses::ApplyPatchTool::OrHash,
                 OpenAI::Responses::WebSearchTool::OrHash,
                 OpenAI::Responses::WebSearchPreviewTool::OrHash

data/rbi/openai/resources/uploads/parts.rbi

@@ -3,6 +3,7 @@
 module OpenAI
   module Resources
     class Uploads
+      # Use Uploads to upload large files in multiple parts.
       class Parts
         # Adds a
         # [Part](https://platform.openai.com/docs/api-reference/uploads/part-object) to an

data/rbi/openai/resources/uploads.rbi

@@ -2,7 +2,9 @@
 
 module OpenAI
   module Resources
+    # Use Uploads to upload large files in multiple parts.
     class Uploads
+      # Use Uploads to upload large files in multiple parts.
       sig { returns(OpenAI::Resources::Uploads::Parts) }
       attr_reader :parts
 

data/rbi/openai/resources/videos.rbi

@@ -17,7 +17,7 @@ module OpenAI
       def create(
         # Text prompt that describes the video to generate.
         prompt:,
-        # Optional image reference that guides generation.
+        # Optional multipart reference asset that guides generation.
         input_reference: nil,
         # The video generation model to use (allowed values: sora-2, sora-2-pro). Defaults
         # to `sora-2`.

data/sig/openai/internal/util.rbs

@@ -106,6 +106,16 @@ module OpenAI
       JSON_CONTENT: Regexp
       JSONL_CONTENT: Regexp
 
+      def encode_query_params: (
+        ::Hash[Symbol, top] query
+      ) -> ::Hash[Symbol, top]
+
+      private def write_query_param_element!: (
+        ::Hash[Symbol, top] collection,
+        String key,
+        top element
+      ) -> nil
+
       def self?.write_multipart_content: (
         Enumerator::Yielder y,
         val: top,

data/sig/openai/models/batch_cancel_params.rbs

@@ -1,14 +1,23 @@
 module OpenAI
   module Models
-    type batch_cancel_params = {  } & OpenAI::Internal::Type::request_parameters
+    type batch_cancel_params =
+      { batch_id: String } & OpenAI::Internal::Type::request_parameters
 
     class BatchCancelParams < OpenAI::Internal::Type::BaseModel
       extend OpenAI::Internal::Type::RequestParameters::Converter
       include OpenAI::Internal::Type::RequestParameters
 
-      def initialize: (?request_options: OpenAI::request_opts) -> void
+      attr_accessor batch_id: String
 
-      def to_hash: -> { request_options: OpenAI::RequestOptions }
+      def initialize: (
+        batch_id: String,
+        ?request_options: OpenAI::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        batch_id: String,
+        request_options: OpenAI::RequestOptions
+      }
     end
   end
 end

data/sig/openai/models/batch_retrieve_params.rbs

@@ -1,15 +1,23 @@
 module OpenAI
   module Models
     type batch_retrieve_params =
-      {  } & OpenAI::Internal::Type::request_parameters
+      { batch_id: String } & OpenAI::Internal::Type::request_parameters
 
     class BatchRetrieveParams < OpenAI::Internal::Type::BaseModel
       extend OpenAI::Internal::Type::RequestParameters::Converter
       include OpenAI::Internal::Type::RequestParameters
 
-      def initialize: (?request_options: OpenAI::request_opts) -> void
+      attr_accessor batch_id: String
 
-      def to_hash: -> { request_options: OpenAI::RequestOptions }
+      def initialize: (
+        batch_id: String,
+        ?request_options: OpenAI::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        batch_id: String,
+        request_options: OpenAI::RequestOptions
+      }
     end
   end
 end

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

@@ -2,15 +2,23 @@ module OpenAI
   module Models
     module Beta
       type assistant_delete_params =
-        {  } & OpenAI::Internal::Type::request_parameters
+        { assistant_id: String } & OpenAI::Internal::Type::request_parameters
 
       class AssistantDeleteParams < OpenAI::Internal::Type::BaseModel
         extend OpenAI::Internal::Type::RequestParameters::Converter
         include OpenAI::Internal::Type::RequestParameters
 
-        def initialize: (?request_options: OpenAI::request_opts) -> void
+        attr_accessor assistant_id: String
 
-        def to_hash: -> { request_options: OpenAI::RequestOptions }
+        def initialize: (
+          assistant_id: String,
+          ?request_options: OpenAI::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          assistant_id: String,
+          request_options: OpenAI::RequestOptions
+        }
       end
     end
   end

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

@@ -2,15 +2,23 @@ module OpenAI
   module Models
     module Beta
       type assistant_retrieve_params =
-        {  } & OpenAI::Internal::Type::request_parameters
+        { assistant_id: String } & OpenAI::Internal::Type::request_parameters
 
       class AssistantRetrieveParams < OpenAI::Internal::Type::BaseModel
         extend OpenAI::Internal::Type::RequestParameters::Converter
         include OpenAI::Internal::Type::RequestParameters
 
-        def initialize: (?request_options: OpenAI::request_opts) -> void
+        attr_accessor assistant_id: String
 
-        def to_hash: -> { request_options: OpenAI::RequestOptions }
+        def initialize: (
+          assistant_id: String,
+          ?request_options: OpenAI::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          assistant_id: String,
+          request_options: OpenAI::RequestOptions
+        }
       end
     end
   end

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

@@ -3,6 +3,7 @@ module OpenAI
     module Beta
       type assistant_update_params =
         {
+          assistant_id: String,
           description: String?,
           instructions: String?,
           metadata: OpenAI::Models::metadata?,
@@ -21,6 +22,8 @@ module OpenAI
         extend OpenAI::Internal::Type::RequestParameters::Converter
         include OpenAI::Internal::Type::RequestParameters
 
+        attr_accessor assistant_id: String
+
         attr_accessor description: String?
 
         attr_accessor instructions: String?
@@ -52,6 +55,7 @@ module OpenAI
         attr_accessor top_p: Float?
 
         def initialize: (
+          assistant_id: String,
           ?description: String?,
           ?instructions: String?,
           ?metadata: OpenAI::Models::metadata?,
@@ -67,6 +71,7 @@ module OpenAI
         ) -> void
 
         def to_hash: -> {
+          assistant_id: String,
           description: String?,
           instructions: String?,
           metadata: OpenAI::Models::metadata?,

data/sig/openai/models/beta/chatkit/session_cancel_params.rbs

@@ -3,15 +3,23 @@ module OpenAI
     module Beta
       module ChatKit
         type session_cancel_params =
-          {  } & OpenAI::Internal::Type::request_parameters
+          { session_id: String } & OpenAI::Internal::Type::request_parameters
 
         class SessionCancelParams < OpenAI::Internal::Type::BaseModel
           extend OpenAI::Internal::Type::RequestParameters::Converter
           include OpenAI::Internal::Type::RequestParameters
 
-          def initialize: (?request_options: OpenAI::request_opts) -> void
+          attr_accessor session_id: String
 
-          def to_hash: -> { request_options: OpenAI::RequestOptions }
+          def initialize: (
+            session_id: String,
+            ?request_options: OpenAI::request_opts
+          ) -> void
+
+          def to_hash: -> {
+            session_id: String,
+            request_options: OpenAI::RequestOptions
+          }
         end
       end
     end