openai 0.71.0 → 0.73.0

data/rbi/openai/models/admin/organization/spend_limit_update_params.rbi

@@ -0,0 +1,141 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        class SpendLimitUpdateParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Admin::Organization::SpendLimitUpdateParams,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The currency for the threshold amount. Currently, only `USD` is supported.
+          sig do
+            returns(
+              OpenAI::Admin::Organization::SpendLimitUpdateParams::Currency::OrSymbol
+            )
+          end
+          attr_accessor :currency
+
+          # The time interval for evaluating spend against the threshold. Currently, only
+          # `month` is supported.
+          sig do
+            returns(
+              OpenAI::Admin::Organization::SpendLimitUpdateParams::Interval::OrSymbol
+            )
+          end
+          attr_accessor :interval
+
+          # The hard spend limit amount, in cents.
+          sig { returns(Integer) }
+          attr_accessor :threshold_amount
+
+          sig do
+            params(
+              currency:
+                OpenAI::Admin::Organization::SpendLimitUpdateParams::Currency::OrSymbol,
+              interval:
+                OpenAI::Admin::Organization::SpendLimitUpdateParams::Interval::OrSymbol,
+              threshold_amount: Integer,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The currency for the threshold amount. Currently, only `USD` is supported.
+            currency:,
+            # The time interval for evaluating spend against the threshold. Currently, only
+            # `month` is supported.
+            interval:,
+            # The hard spend limit amount, in cents.
+            threshold_amount:,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                currency:
+                  OpenAI::Admin::Organization::SpendLimitUpdateParams::Currency::OrSymbol,
+                interval:
+                  OpenAI::Admin::Organization::SpendLimitUpdateParams::Interval::OrSymbol,
+                threshold_amount: Integer,
+                request_options: OpenAI::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The currency for the threshold amount. Currently, only `USD` is supported.
+          module Currency
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  OpenAI::Admin::Organization::SpendLimitUpdateParams::Currency
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            USD =
+              T.let(
+                :USD,
+                OpenAI::Admin::Organization::SpendLimitUpdateParams::Currency::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Admin::Organization::SpendLimitUpdateParams::Currency::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          # The time interval for evaluating spend against the threshold. Currently, only
+          # `month` is supported.
+          module Interval
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  OpenAI::Admin::Organization::SpendLimitUpdateParams::Interval
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            MONTH =
+              T.let(
+                :month,
+                OpenAI::Admin::Organization::SpendLimitUpdateParams::Interval::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Admin::Organization::SpendLimitUpdateParams::Interval::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/audio/transcription.rbi

@@ -13,6 +13,20 @@ module OpenAI
         sig { returns(String) }
         attr_accessor :text
 
+        # The languages detected in the audio. Returned by `gpt-transcribe`. An empty
+        # array indicates that no language could be reliably detected.
+        sig do
+          returns(T.nilable(T::Array[OpenAI::Audio::TranscriptionLanguage]))
+        end
+        attr_reader :languages
+
+        sig do
+          params(
+            languages: T::Array[OpenAI::Audio::TranscriptionLanguage::OrHash]
+          ).void
+        end
+        attr_writer :languages
+
         # The log probabilities of the tokens in the transcription. Only returned with the
         # models `gpt-4o-transcribe` and `gpt-4o-mini-transcribe` if `logprobs` is added
         # to the `include` array.
@@ -50,6 +64,7 @@ module OpenAI
         sig do
           params(
             text: String,
+            languages: T::Array[OpenAI::Audio::TranscriptionLanguage::OrHash],
             logprobs: T::Array[OpenAI::Audio::Transcription::Logprob::OrHash],
             usage:
               T.any(
@@ -61,6 +76,9 @@ module OpenAI
         def self.new(
           # The transcribed text.
           text:,
+          # The languages detected in the audio. Returned by `gpt-transcribe`. An empty
+          # array indicates that no language could be reliably detected.
+          languages: nil,
           # The log probabilities of the tokens in the transcription. Only returned with the
           # models `gpt-4o-transcribe` and `gpt-4o-mini-transcribe` if `logprobs` is added
           # to the `include` array.
@@ -74,6 +92,7 @@ module OpenAI
           override.returns(
             {
               text: String,
+              languages: T::Array[OpenAI::Audio::TranscriptionLanguage],
               logprobs: T::Array[OpenAI::Audio::Transcription::Logprob],
               usage: OpenAI::Audio::Transcription::Usage::Variants
             }

data/rbi/openai/models/audio/transcription_create_params.rbi

@@ -20,7 +20,7 @@ module OpenAI
         sig { returns(OpenAI::Internal::FileInput) }
         attr_accessor :file
 
-        # ID of the model to use. The options are `gpt-4o-transcribe`,
+        # ID of the model to use. The options are `gpt-transcribe`, `gpt-4o-transcribe`,
         # `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `whisper-1`
         # (which is powered by our open source Whisper V2 model), and
         # `gpt-4o-transcribe-diarize`.
@@ -65,6 +65,14 @@ module OpenAI
         end
         attr_writer :include
 
+        # Words or phrases to guide transcription of the input audio. Supported by
+        # `gpt-transcribe`.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :keywords
+
+        sig { params(keywords: T::Array[String]).void }
+        attr_writer :keywords
+
         # Optional list of speaker names that correspond to the audio samples provided in
         # `known_speaker_references[]`. Each entry should be a short identifier (for
         # example `customer` or `agent`). Up to 4 speakers are supported.
@@ -94,6 +102,15 @@ module OpenAI
         sig { params(language: String).void }
         attr_writer :language
 
+        # Possible languages of the input audio, in
+        # [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
+        # Supported by `gpt-transcribe`.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :languages
+
+        sig { params(languages: T::Array[String]).void }
+        attr_writer :languages
+
         # 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)
@@ -168,9 +185,11 @@ module OpenAI
                 )
               ),
             include: T::Array[OpenAI::Audio::TranscriptionInclude::OrSymbol],
+            keywords: T::Array[String],
             known_speaker_names: T::Array[String],
             known_speaker_references: T::Array[String],
             language: String,
+            languages: T::Array[String],
             prompt: String,
             response_format: OpenAI::AudioResponseFormat::OrSymbol,
             temperature: Float,
@@ -185,7 +204,7 @@ module OpenAI
           # The audio file object (not file name) to transcribe, in one of these formats:
           # flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.
           file:,
-          # ID of the model to use. The options are `gpt-4o-transcribe`,
+          # ID of the model to use. The options are `gpt-transcribe`, `gpt-4o-transcribe`,
           # `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `whisper-1`
           # (which is powered by our open source Whisper V2 model), and
           # `gpt-4o-transcribe-diarize`.
@@ -204,6 +223,9 @@ module OpenAI
           # `gpt-4o-mini-transcribe`, and `gpt-4o-mini-transcribe-2025-12-15`. This field is
           # not supported when using `gpt-4o-transcribe-diarize`.
           include: nil,
+          # Words or phrases to guide transcription of the input audio. Supported by
+          # `gpt-transcribe`.
+          keywords: nil,
           # Optional list of speaker names that correspond to the audio samples provided in
           # `known_speaker_references[]`. Each entry should be a short identifier (for
           # example `customer` or `agent`). Up to 4 speakers are supported.
@@ -218,6 +240,10 @@ module OpenAI
           # [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) (e.g. `en`)
           # format will improve accuracy and latency.
           language: nil,
+          # Possible languages of the input audio, in
+          # [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
+          # Supported by `gpt-transcribe`.
+          languages: nil,
           # 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)
@@ -260,9 +286,11 @@ module OpenAI
                   )
                 ),
               include: T::Array[OpenAI::Audio::TranscriptionInclude::OrSymbol],
+              keywords: T::Array[String],
               known_speaker_names: T::Array[String],
               known_speaker_references: T::Array[String],
               language: String,
+              languages: T::Array[String],
               prompt: String,
               response_format: OpenAI::AudioResponseFormat::OrSymbol,
               temperature: Float,
@@ -277,7 +305,7 @@ module OpenAI
         def to_hash
         end
 
-        # ID of the model to use. The options are `gpt-4o-transcribe`,
+        # ID of the model to use. The options are `gpt-transcribe`, `gpt-4o-transcribe`,
         # `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `whisper-1`
         # (which is powered by our open source Whisper V2 model), and
         # `gpt-4o-transcribe-diarize`.

data/rbi/openai/models/audio/transcription_language.rbi

@@ -0,0 +1,33 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Audio
+      class TranscriptionLanguage < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Audio::TranscriptionLanguage,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The code of a language detected in the audio.
+        sig { returns(String) }
+        attr_accessor :code
+
+        # A language detected in transcribed audio.
+        sig { params(code: String).returns(T.attached_class) }
+        def self.new(
+          # The code of a language detected in the audio.
+          code:
+        )
+        end
+
+        sig { override.returns({ code: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

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

@@ -20,6 +20,20 @@ module OpenAI
         sig { returns(Symbol) }
         attr_accessor :type
 
+        # The languages detected in the audio. Returned by `gpt-transcribe`. An empty
+        # array indicates that no language could be reliably detected.
+        sig do
+          returns(T.nilable(T::Array[OpenAI::Audio::TranscriptionLanguage]))
+        end
+        attr_reader :languages
+
+        sig do
+          params(
+            languages: T::Array[OpenAI::Audio::TranscriptionLanguage::OrHash]
+          ).void
+        end
+        attr_writer :languages
+
         # 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)
@@ -63,6 +77,7 @@ module OpenAI
         sig do
           params(
             text: String,
+            languages: T::Array[OpenAI::Audio::TranscriptionLanguage::OrHash],
             logprobs:
               T::Array[
                 OpenAI::Audio::TranscriptionTextDoneEvent::Logprob::OrHash
@@ -74,6 +89,9 @@ module OpenAI
         def self.new(
           # The text that was transcribed.
           text:,
+          # The languages detected in the audio. Returned by `gpt-transcribe`. An empty
+          # array indicates that no language could be reliably detected.
+          languages: nil,
           # 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)
@@ -91,6 +109,7 @@ module OpenAI
             {
               text: String,
               type: Symbol,
+              languages: T::Array[OpenAI::Audio::TranscriptionLanguage],
               logprobs:
                 T::Array[OpenAI::Audio::TranscriptionTextDoneEvent::Logprob],
               usage: OpenAI::Audio::TranscriptionTextDoneEvent::Usage

data/rbi/openai/models/audio_model.rbi

@@ -9,6 +9,8 @@ module OpenAI
       OrSymbol = T.type_alias { T.any(Symbol, String) }
 
       WHISPER_1 = T.let(:"whisper-1", OpenAI::AudioModel::TaggedSymbol)
+      GPT_TRANSCRIBE =
+        T.let(:"gpt-transcribe", OpenAI::AudioModel::TaggedSymbol)
       GPT_4O_TRANSCRIBE =
         T.let(:"gpt-4o-transcribe", OpenAI::AudioModel::TaggedSymbol)
       GPT_4O_MINI_TRANSCRIBE =

data/rbi/openai/models/beta/beta_response.rbi

@@ -204,10 +204,7 @@ module OpenAI
         # hit rates. Replaces the `user` field.
         # [Learn more](https://platform.openai.com/docs/guides/prompt-caching).
         sig { returns(T.nilable(String)) }
-        attr_reader :prompt_cache_key
-
-        sig { params(prompt_cache_key: String).void }
-        attr_writer :prompt_cache_key
+        attr_accessor :prompt_cache_key
 
         # The prompt-caching options that were applied to the response. Supported for
         # `gpt-5.6` and later models.
@@ -271,10 +268,7 @@ module OpenAI
         # identifying information.
         # [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).
         sig { returns(T.nilable(String)) }
-        attr_reader :safety_identifier
-
-        sig { params(safety_identifier: String).void }
-        attr_writer :safety_identifier
+        attr_accessor :safety_identifier
 
         # Specifies the processing type used for serving the request.
         #
@@ -452,7 +446,7 @@ module OpenAI
               T.nilable(OpenAI::Beta::BetaResponse::Moderation::OrHash),
             previous_response_id: T.nilable(String),
             prompt: T.nilable(OpenAI::Beta::BetaResponsePrompt::OrHash),
-            prompt_cache_key: String,
+            prompt_cache_key: T.nilable(String),
             prompt_cache_options:
               OpenAI::Beta::BetaResponse::PromptCacheOptions::OrHash,
             prompt_cache_retention:
@@ -460,7 +454,7 @@ module OpenAI
                 OpenAI::Beta::BetaResponse::PromptCacheRetention::OrSymbol
               ),
             reasoning: T.nilable(OpenAI::Beta::BetaResponse::Reasoning::OrHash),
-            safety_identifier: String,
+            safety_identifier: T.nilable(String),
             service_tier:
               T.nilable(OpenAI::Beta::BetaResponse::ServiceTier::OrSymbol),
             status: OpenAI::Beta::BetaResponseStatus::OrSymbol,
@@ -691,7 +685,7 @@ module OpenAI
               moderation: T.nilable(OpenAI::Beta::BetaResponse::Moderation),
               previous_response_id: T.nilable(String),
               prompt: T.nilable(OpenAI::Beta::BetaResponsePrompt),
-              prompt_cache_key: String,
+              prompt_cache_key: T.nilable(String),
               prompt_cache_options:
                 OpenAI::Beta::BetaResponse::PromptCacheOptions,
               prompt_cache_retention:
@@ -699,7 +693,7 @@ module OpenAI
                   OpenAI::Beta::BetaResponse::PromptCacheRetention::TaggedSymbol
                 ),
               reasoning: T.nilable(OpenAI::Beta::BetaResponse::Reasoning),
-              safety_identifier: String,
+              safety_identifier: T.nilable(String),
               service_tier:
                 T.nilable(
                   OpenAI::Beta::BetaResponse::ServiceTier::TaggedSymbol
@@ -2014,7 +2008,10 @@ module OpenAI
               )
             end
 
-          # Controls which reasoning items are rendered back to the model on later turns.
+          # Controls which reasoning items are rendered back to the model on later turns. If
+          # omitted or set to `auto`, the model determines the context mode. The `gpt-5.6`
+          # model family defaults to `all_turns`; earlier models default to `current_turn`.
+          #
           # When returned on a response, this is the effective reasoning context mode used
           # for the response.
           sig do
@@ -2121,7 +2118,10 @@ module OpenAI
             ).returns(T.attached_class)
           end
           def self.new(
-            # Controls which reasoning items are rendered back to the model on later turns.
+            # Controls which reasoning items are rendered back to the model on later turns. If
+            # omitted or set to `auto`, the model determines the context mode. The `gpt-5.6`
+            # model family defaults to `all_turns`; earlier models default to `current_turn`.
+            #
             # When returned on a response, this is the effective reasoning context mode used
             # for the response.
             context: nil,
@@ -2178,7 +2178,10 @@ module OpenAI
           def to_hash
           end
 
-          # Controls which reasoning items are rendered back to the model on later turns.
+          # Controls which reasoning items are rendered back to the model on later turns. If
+          # omitted or set to `auto`, the model determines the context mode. The `gpt-5.6`
+          # model family defaults to `all_turns`; earlier models default to `current_turn`.
+          #
           # When returned on a response, this is the effective reasoning context mode used
           # for the response.
           module Context

data/rbi/openai/models/beta/beta_response_error.rbi

@@ -70,6 +70,11 @@ module OpenAI
               :invalid_prompt,
               OpenAI::Beta::BetaResponseError::Code::TaggedSymbol
             )
+          DATA_RESIDENCY_MISMATCH =
+            T.let(
+              :data_residency_mismatch,
+              OpenAI::Beta::BetaResponseError::Code::TaggedSymbol
+            )
           BIO_POLICY =
             T.let(
               :bio_policy,

data/rbi/openai/models/beta/beta_response_text_config.rbi

@@ -54,7 +54,8 @@ module OpenAI
 
         # Constrains the verbosity of the model's response. Lower values will result in
         # more concise responses, while higher values will result in more verbose
-        # responses. Currently supported values are `low`, `medium`, and `high`.
+        # responses. Currently supported values are `low`, `medium`, and `high`. The
+        # default is `medium`.
         sig do
           returns(
             T.nilable(OpenAI::Beta::BetaResponseTextConfig::Verbosity::OrSymbol)
@@ -98,7 +99,8 @@ module OpenAI
           format_: nil,
           # Constrains the verbosity of the model's response. Lower values will result in
           # more concise responses, while higher values will result in more verbose
-          # responses. Currently supported values are `low`, `medium`, and `high`.
+          # responses. Currently supported values are `low`, `medium`, and `high`. The
+          # default is `medium`.
           verbosity: nil
         )
         end
@@ -124,7 +126,8 @@ module OpenAI
 
         # Constrains the verbosity of the model's response. Lower values will result in
         # more concise responses, while higher values will result in more verbose
-        # responses. Currently supported values are `low`, `medium`, and `high`.
+        # responses. Currently supported values are `low`, `medium`, and `high`. The
+        # default is `medium`.
         module Verbosity
           extend OpenAI::Internal::Type::Enum
 

data/rbi/openai/models/beta/beta_responses_client_event.rbi

@@ -238,10 +238,7 @@ module OpenAI
           # hit rates. Replaces the `user` field.
           # [Learn more](https://platform.openai.com/docs/guides/prompt-caching).
           sig { returns(T.nilable(String)) }
-          attr_reader :prompt_cache_key
-
-          sig { params(prompt_cache_key: String).void }
-          attr_writer :prompt_cache_key
+          attr_accessor :prompt_cache_key
 
           # Options for prompt caching. Supported for `gpt-5.6` and later models. By
           # default, OpenAI automatically chooses one implicit cache breakpoint. You can add
@@ -325,10 +322,7 @@ module OpenAI
           # identifying information.
           # [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).
           sig { returns(T.nilable(String)) }
-          attr_reader :safety_identifier
-
-          sig { params(safety_identifier: String).void }
-          attr_writer :safety_identifier
+          attr_accessor :safety_identifier
 
           # Specifies the processing type used for serving the request.
           #
@@ -612,7 +606,7 @@ module OpenAI
               parallel_tool_calls: T.nilable(T::Boolean),
               previous_response_id: T.nilable(String),
               prompt: T.nilable(OpenAI::Beta::BetaResponsePrompt::OrHash),
-              prompt_cache_key: String,
+              prompt_cache_key: T.nilable(String),
               prompt_cache_options:
                 OpenAI::Beta::BetaResponsesClientEvent::ResponseCreate::PromptCacheOptions::OrHash,
               prompt_cache_retention:
@@ -623,7 +617,7 @@ module OpenAI
                 T.nilable(
                   OpenAI::Beta::BetaResponsesClientEvent::ResponseCreate::Reasoning::OrHash
                 ),
-              safety_identifier: String,
+              safety_identifier: T.nilable(String),
               service_tier:
                 T.nilable(
                   OpenAI::Beta::BetaResponsesClientEvent::ResponseCreate::ServiceTier::OrSymbol
@@ -938,7 +932,7 @@ module OpenAI
                 parallel_tool_calls: T.nilable(T::Boolean),
                 previous_response_id: T.nilable(String),
                 prompt: T.nilable(OpenAI::Beta::BetaResponsePrompt),
-                prompt_cache_key: String,
+                prompt_cache_key: T.nilable(String),
                 prompt_cache_options:
                   OpenAI::Beta::BetaResponsesClientEvent::ResponseCreate::PromptCacheOptions,
                 prompt_cache_retention:
@@ -949,7 +943,7 @@ module OpenAI
                   T.nilable(
                     OpenAI::Beta::BetaResponsesClientEvent::ResponseCreate::Reasoning
                   ),
-                safety_identifier: String,
+                safety_identifier: T.nilable(String),
                 service_tier:
                   T.nilable(
                     OpenAI::Beta::BetaResponsesClientEvent::ResponseCreate::ServiceTier::OrSymbol
@@ -2198,7 +2192,10 @@ module OpenAI
                 )
               end
 
-            # Controls which reasoning items are rendered back to the model on later turns.
+            # Controls which reasoning items are rendered back to the model on later turns. If
+            # omitted or set to `auto`, the model determines the context mode. The `gpt-5.6`
+            # model family defaults to `all_turns`; earlier models default to `current_turn`.
+            #
             # When returned on a response, this is the effective reasoning context mode used
             # for the response.
             sig do
@@ -2310,7 +2307,10 @@ module OpenAI
               ).returns(T.attached_class)
             end
             def self.new(
-              # Controls which reasoning items are rendered back to the model on later turns.
+              # Controls which reasoning items are rendered back to the model on later turns. If
+              # omitted or set to `auto`, the model determines the context mode. The `gpt-5.6`
+              # model family defaults to `all_turns`; earlier models default to `current_turn`.
+              #
               # When returned on a response, this is the effective reasoning context mode used
               # for the response.
               context: nil,
@@ -2371,7 +2371,10 @@ module OpenAI
             def to_hash
             end
 
-            # Controls which reasoning items are rendered back to the model on later turns.
+            # Controls which reasoning items are rendered back to the model on later turns. If
+            # omitted or set to `auto`, the model determines the context mode. The `gpt-5.6`
+            # model family defaults to `all_turns`; earlier models default to `current_turn`.
+            #
             # When returned on a response, this is the effective reasoning context mode used
             # for the response.
             module Context