openai 0.87.0 → 0.88.0

data/rbi/openai/models/audio/transcription_text_delta_event.rbi

@@ -23,7 +23,7 @@ module OpenAI
         attr_accessor :type
 
         # The log probabilities of the delta. Only included if you
-        # [create a transcription](https://platform.openai.com/docs/api-reference/audio/create-transcription)
+        # [create a transcription](https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create)
         # with the `include[]` parameter set to `logprobs`.
         sig { returns(T.nilable(T::Array[OpenAI::Audio::TranscriptionTextDeltaEvent::Logprob])) }
         attr_reader :logprobs
@@ -41,7 +41,7 @@ module OpenAI
 
         # Emitted when there is an additional text delta. This is also the first event
         # emitted when the transcription starts. Only emitted when you
-        # [create a transcription](https://platform.openai.com/docs/api-reference/audio/create-transcription)
+        # [create a transcription](https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create)
         # with the `Stream` parameter set to `true`.
         sig do
           params(
@@ -62,7 +62,7 @@ module OpenAI
           delta:,
 
           # The log probabilities of the delta. Only included if you
-          # [create a transcription](https://platform.openai.com/docs/api-reference/audio/create-transcription)
+          # [create a transcription](https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create)
           # with the `include[]` parameter set to `logprobs`.
           logprobs: nil,
 

data/rbi/openai/models/audio/transcription_text_done_event.rbi

@@ -32,7 +32,7 @@ module OpenAI
 
         # The log probabilities of the individual tokens in the transcription. Only
         # included if you
-        # [create a transcription](https://platform.openai.com/docs/api-reference/audio/create-transcription)
+        # [create a transcription](https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create)
         # with the `include[]` parameter set to `logprobs`.
         sig { returns(T.nilable(T::Array[OpenAI::Audio::TranscriptionTextDoneEvent::Logprob])) }
         attr_reader :logprobs
@@ -49,7 +49,7 @@ module OpenAI
 
         # Emitted when the transcription is complete. Contains the complete transcription
         # text. Only emitted when you
-        # [create a transcription](https://platform.openai.com/docs/api-reference/audio/create-transcription)
+        # [create a transcription](https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create)
         # with the `Stream` parameter set to `true`.
         sig do
           params(
@@ -77,7 +77,7 @@ module OpenAI
 
           # The log probabilities of the individual tokens in the transcription. Only
           # included if you
-          # [create a transcription](https://platform.openai.com/docs/api-reference/audio/create-transcription)
+          # [create a transcription](https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create)
           # with the `include[]` parameter set to `logprobs`.
           logprobs: nil,
 

data/rbi/openai/models/audio/transcription_text_segment_event.rbi

@@ -40,7 +40,7 @@ module OpenAI
 
         # Emitted when a diarized transcription returns a completed segment with speaker
         # information. Only emitted when you
-        # [create a transcription](https://platform.openai.com/docs/api-reference/audio/create-transcription)
+        # [create a transcription](https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create)
         # with `stream` set to `true` and `response_format` set to `diarized_json`.
         sig do
           params(

data/rbi/openai/models/audio/translation_create_params.rbi

@@ -35,7 +35,7 @@ module OpenAI
 
         # An optional text to guide the model's style or continue a previous audio
         # segment. The
-        # [prompt](https://platform.openai.com/docs/guides/speech-to-text#prompting)
+        # [prompt](https://developers.openai.com/api/docs/guides/speech-to-text#prompting)
         # should be in English.
         sig { returns(T.nilable(String)) }
         attr_reader :prompt
@@ -97,7 +97,7 @@ module OpenAI
 
           # An optional text to guide the model's style or continue a previous audio
           # segment. The
-          # [prompt](https://platform.openai.com/docs/guides/speech-to-text#prompting)
+          # [prompt](https://developers.openai.com/api/docs/guides/speech-to-text#prompting)
           # should be in English.
           prompt: nil,
 

data/rbi/openai/models/batch.rbi

@@ -120,8 +120,8 @@ module OpenAI
       # Model ID used to process the batch, like `gpt-6-astra`. OpenAI offers a wide
       # range of models with different capabilities, performance characteristics, and
       # price points. Refer to the
-      # [model guide](https://platform.openai.com/docs/models) to browse and compare
-      # available models.
+      # [model guide](https://developers.openai.com/api/docs/models) to browse and
+      # compare available models.
       sig { returns(T.nilable(String)) }
       attr_reader :model
 
@@ -259,8 +259,8 @@ module OpenAI
         # Model ID used to process the batch, like `gpt-6-astra`. OpenAI offers a wide
         # range of models with different capabilities, performance characteristics, and
         # price points. Refer to the
-        # [model guide](https://platform.openai.com/docs/models) to browse and compare
-        # available models.
+        # [model guide](https://developers.openai.com/api/docs/models) to browse and
+        # compare available models.
         model: nil,
 
         # The ID of the file containing the outputs of successfully executed requests.

data/rbi/openai/models/batch_create_params.rbi

@@ -31,11 +31,12 @@ module OpenAI
 
       # The ID of an uploaded file that contains requests for the new batch.
       #
-      # See [upload file](https://platform.openai.com/docs/api-reference/files/create)
+      # See
+      # [upload file](https://developers.openai.com/api/reference/resources/files/methods/create)
       # for how to upload a file.
       #
       # Your input file must be formatted as a
-      # [JSONL file](https://platform.openai.com/docs/api-reference/batch/request-input),
+      # [JSONL file](https://developers.openai.com/api/docs/guides/batch#1-prepare-your-batch-file),
       # and must be uploaded with the purpose `batch`. The file can contain up to 50,000
       # requests, and can be up to 200 MB in size.
       sig { returns(String) }
@@ -91,11 +92,12 @@ module OpenAI
 
         # The ID of an uploaded file that contains requests for the new batch.
         #
-        # See [upload file](https://platform.openai.com/docs/api-reference/files/create)
+        # See
+        # [upload file](https://developers.openai.com/api/reference/resources/files/methods/create)
         # for how to upload a file.
         #
         # Your input file must be formatted as a
-        # [JSONL file](https://platform.openai.com/docs/api-reference/batch/request-input),
+        # [JSONL file](https://developers.openai.com/api/docs/guides/batch#1-prepare-your-batch-file),
         # and must be uploaded with the purpose `batch`. The file can contain up to 50,000
         # requests, and can be up to 200 MB in size.
         input_file_id:,

data/rbi/openai/models/batch_usage.rbi

@@ -99,7 +99,7 @@ module OpenAI
         end
 
         # The number of tokens that were retrieved from the cache.
-        # [More on prompt caching](https://platform.openai.com/docs/guides/prompt-caching).
+        # [More on prompt caching](https://developers.openai.com/api/docs/guides/prompt-caching).
         sig { returns(Integer) }
         attr_accessor :cached_tokens
 
@@ -114,7 +114,7 @@ module OpenAI
         def self.new(
 
           # The number of tokens that were retrieved from the cache.
-          # [More on prompt caching](https://platform.openai.com/docs/guides/prompt-caching).
+          # [More on prompt caching](https://developers.openai.com/api/docs/guides/prompt-caching).
 
           cached_tokens:
         )

data/rbi/openai/models/beta/assistant.rbi

@@ -41,10 +41,10 @@ module OpenAI
         attr_accessor :metadata
 
         # ID of the model to use. You can use the
-        # [List models](https://platform.openai.com/docs/api-reference/models/list) API to
-        # see all of your available models, or see our
-        # [Model overview](https://platform.openai.com/docs/models) for descriptions of
-        # them.
+        # [List models](https://developers.openai.com/api/reference/resources/models/methods/list)
+        # API to see all of your available models, or see our
+        # [Model overview](https://developers.openai.com/api/docs/models) for descriptions
+        # of them.
         sig { returns(String) }
         attr_accessor :model
 
@@ -63,14 +63,14 @@ module OpenAI
         attr_accessor :tools
 
         # Specifies the format that the model must output. Compatible with
-        # [GPT-4o](https://platform.openai.com/docs/models#gpt-4o),
-        # [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4),
-        # and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
+        # [GPT-4o](https://developers.openai.com/api/docs/models/gpt-4o),
+        # [GPT-4 Turbo](https://developers.openai.com/api/docs/models/gpt-4-turbo), and
+        # all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
         #
         # Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured
         # Outputs which ensures the model will match your supplied JSON schema. Learn more
         # in the
-        # [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).
+        # [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
         #
         # Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the
         # message the model generates is valid JSON.
@@ -178,10 +178,10 @@ module OpenAI
           metadata:,
 
           # ID of the model to use. You can use the
-          # [List models](https://platform.openai.com/docs/api-reference/models/list) API to
-          # see all of your available models, or see our
-          # [Model overview](https://platform.openai.com/docs/models) for descriptions of
-          # them.
+          # [List models](https://developers.openai.com/api/reference/resources/models/methods/list)
+          # API to see all of your available models, or see our
+          # [Model overview](https://developers.openai.com/api/docs/models) for descriptions
+          # of them.
           model:,
 
           # The name of the assistant. The maximum length is 256 characters.
@@ -193,14 +193,14 @@ module OpenAI
           tools:,
 
           # Specifies the format that the model must output. Compatible with
-          # [GPT-4o](https://platform.openai.com/docs/models#gpt-4o),
-          # [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4),
-          # and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
+          # [GPT-4o](https://developers.openai.com/api/docs/models/gpt-4o),
+          # [GPT-4 Turbo](https://developers.openai.com/api/docs/models/gpt-4-turbo), and
+          # all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
           #
           # Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured
           # Outputs which ensures the model will match your supplied JSON schema. Learn more
           # in the
-          # [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).
+          # [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
           #
           # Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the
           # message the model generates is valid JSON.
@@ -320,9 +320,9 @@ module OpenAI
               )
             end
 
-            # A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made
-            # available to the `code_interpreter`` tool. There can be a maximum of 20 files
-            # associated with the tool.
+            # A list of [file](https://developers.openai.com/api/reference/resources/files)
+            # IDs made available to the `code_interpreter`` tool. There can be a maximum of 20
+            # files associated with the tool.
             sig { returns(T.nilable(T::Array[String])) }
             attr_reader :file_ids
 
@@ -338,9 +338,9 @@ module OpenAI
             end
             def self.new(
 
-              # A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made
-              # available to the `code_interpreter`` tool. There can be a maximum of 20 files
-              # associated with the tool.
+              # A list of [file](https://developers.openai.com/api/reference/resources/files)
+              # IDs made available to the `code_interpreter`` tool. There can be a maximum of 20
+              # files associated with the tool.
 
               file_ids: nil
             )
@@ -365,7 +365,7 @@ module OpenAI
             end
 
             # The ID of the
-            # [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object)
+            # [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
             # attached to this assistant. There can be a maximum of 1 vector store attached to
             # the assistant.
             sig { returns(T.nilable(T::Array[String])) }
@@ -384,7 +384,7 @@ module OpenAI
             def self.new(
 
               # The ID of the
-              # [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object)
+              # [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
               # attached to this assistant. There can be a maximum of 1 vector store attached to
               # the assistant.
 

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

@@ -18,10 +18,10 @@ module OpenAI
         end
 
         # ID of the model to use. You can use the
-        # [List models](https://platform.openai.com/docs/api-reference/models/list) API to
-        # see all of your available models, or see our
-        # [Model overview](https://platform.openai.com/docs/models) for descriptions of
-        # them.
+        # [List models](https://developers.openai.com/api/reference/resources/models/methods/list)
+        # API to see all of your available models, or see our
+        # [Model overview](https://developers.openai.com/api/docs/models) for descriptions
+        # of them.
         sig { returns(T.any(String, OpenAI::ChatModel::OrSymbol)) }
         attr_accessor :model
 
@@ -51,20 +51,20 @@ module OpenAI
         # are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
         # reasoning effort can result in faster responses and fewer tokens used on
         # reasoning in a response. Not all reasoning models support every value. See the
-        # [reasoning guide](https://platform.openai.com/docs/guides/reasoning) for
+        # [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for
         # model-specific support.
         sig { returns(T.nilable(OpenAI::ReasoningEffort::OrSymbol)) }
         attr_accessor :reasoning_effort
 
         # Specifies the format that the model must output. Compatible with
-        # [GPT-4o](https://platform.openai.com/docs/models#gpt-4o),
-        # [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4),
-        # and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
+        # [GPT-4o](https://developers.openai.com/api/docs/models/gpt-4o),
+        # [GPT-4 Turbo](https://developers.openai.com/api/docs/models/gpt-4-turbo), and
+        # all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
         #
         # Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured
         # Outputs which ensures the model will match your supplied JSON schema. Learn more
         # in the
-        # [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).
+        # [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
         #
         # Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the
         # message the model generates is valid JSON.
@@ -187,10 +187,10 @@ module OpenAI
         def self.new(
 
           # ID of the model to use. You can use the
-          # [List models](https://platform.openai.com/docs/api-reference/models/list) API to
-          # see all of your available models, or see our
-          # [Model overview](https://platform.openai.com/docs/models) for descriptions of
-          # them.
+          # [List models](https://developers.openai.com/api/reference/resources/models/methods/list)
+          # API to see all of your available models, or see our
+          # [Model overview](https://developers.openai.com/api/docs/models) for descriptions
+          # of them.
           model:,
 
           # The description of the assistant. The maximum length is 512 characters.
@@ -215,19 +215,19 @@ module OpenAI
           # are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
           # reasoning effort can result in faster responses and fewer tokens used on
           # reasoning in a response. Not all reasoning models support every value. See the
-          # [reasoning guide](https://platform.openai.com/docs/guides/reasoning) for
+          # [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for
           # model-specific support.
           reasoning_effort: nil,
 
           # Specifies the format that the model must output. Compatible with
-          # [GPT-4o](https://platform.openai.com/docs/models#gpt-4o),
-          # [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4),
-          # and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
+          # [GPT-4o](https://developers.openai.com/api/docs/models/gpt-4o),
+          # [GPT-4 Turbo](https://developers.openai.com/api/docs/models/gpt-4-turbo), and
+          # all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
           #
           # Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured
           # Outputs which ensures the model will match your supplied JSON schema. Learn more
           # in the
-          # [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).
+          # [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
           #
           # Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the
           # message the model generates is valid JSON.
@@ -299,10 +299,10 @@ module OpenAI
         end
 
         # ID of the model to use. You can use the
-        # [List models](https://platform.openai.com/docs/api-reference/models/list) API to
-        # see all of your available models, or see our
-        # [Model overview](https://platform.openai.com/docs/models) for descriptions of
-        # them.
+        # [List models](https://developers.openai.com/api/reference/resources/models/methods/list)
+        # API to see all of your available models, or see our
+        # [Model overview](https://developers.openai.com/api/docs/models) for descriptions
+        # of them.
         module Model
           extend OpenAI::Internal::Type::Union
 
@@ -376,9 +376,9 @@ module OpenAI
               )
             end
 
-            # A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made
-            # available to the `code_interpreter` tool. There can be a maximum of 20 files
-            # associated with the tool.
+            # A list of [file](https://developers.openai.com/api/reference/resources/files)
+            # IDs made available to the `code_interpreter` tool. There can be a maximum of 20
+            # files associated with the tool.
             sig { returns(T.nilable(T::Array[String])) }
             attr_reader :file_ids
 
@@ -394,9 +394,9 @@ module OpenAI
             end
             def self.new(
 
-              # A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made
-              # available to the `code_interpreter` tool. There can be a maximum of 20 files
-              # associated with the tool.
+              # A list of [file](https://developers.openai.com/api/reference/resources/files)
+              # IDs made available to the `code_interpreter` tool. There can be a maximum of 20
+              # files associated with the tool.
 
               file_ids: nil
             )
@@ -421,7 +421,7 @@ module OpenAI
             end
 
             # The
-            # [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object)
+            # [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
             # attached to this assistant. There can be a maximum of 1 vector store attached to
             # the assistant.
             sig { returns(T.nilable(T::Array[String])) }
@@ -431,7 +431,7 @@ module OpenAI
             attr_writer :vector_store_ids
 
             # A helper to create a
-            # [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object)
+            # [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
             # with file_ids and attach it to this assistant. There can be a maximum of 1
             # vector store attached to the assistant.
             sig {
@@ -463,13 +463,13 @@ module OpenAI
             def self.new(
 
               # The
-              # [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object)
+              # [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
               # attached to this assistant. There can be a maximum of 1 vector store attached to
               # the assistant.
               vector_store_ids: nil,
 
               # A helper to create a
-              # [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object)
+              # [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
               # with file_ids and attach it to this assistant. There can be a maximum of 1
               # vector store attached to the assistant.
 
@@ -521,10 +521,10 @@ 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. 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.
+              # A list of [file](https://developers.openai.com/api/reference/resources/files)
+              # IDs to 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
 
@@ -560,10 +560,10 @@ 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. 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.
+                # A list of [file](https://developers.openai.com/api/reference/resources/files)
+                # IDs to 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

data/rbi/openai/models/beta/assistant_response_format_option.rbi

@@ -6,14 +6,14 @@ module OpenAI
     module Beta
 
       # Specifies the format that the model must output. Compatible with
-      # [GPT-4o](https://platform.openai.com/docs/models#gpt-4o),
-      # [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4),
-      # and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
+      # [GPT-4o](https://developers.openai.com/api/docs/models/gpt-4o),
+      # [GPT-4 Turbo](https://developers.openai.com/api/docs/models/gpt-4-turbo), and
+      # all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
       #
       # Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured
       # Outputs which ensures the model will match your supplied JSON schema. Learn more
       # in the
-      # [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).
+      # [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
       #
       # Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the
       # message the model generates is valid JSON.