openai 0.98.0 → 0.99.0

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

@@ -206,7 +206,16 @@ module OpenAI
                 sig { params(input_audio_tokens: Integer).void }
                 attr_writer :input_audio_tokens
 
-                # The aggregated number of input tokens written to the cache.
+                # The aggregated number of input tokens written to the cache with a 12-hour
+                # retention period.
+                sig { returns(T.nilable(Integer)) }
+                attr_reader :input_cache_write_12h_tokens
+
+                sig { params(input_cache_write_12h_tokens: Integer).void }
+                attr_writer :input_cache_write_12h_tokens
+
+                # The aggregated number of input tokens written to the cache with a 30-minute
+                # retention period.
                 sig { returns(T.nilable(Integer)) }
                 attr_reader :input_cache_write_tokens
 
@@ -322,6 +331,8 @@ module OpenAI
 
                     input_audio_tokens: Integer,
 
+                    input_cache_write_12h_tokens: Integer,
+
                     input_cache_write_tokens: Integer,
 
                     input_cached_audio_tokens: Integer,
@@ -382,7 +393,12 @@ module OpenAI
                   # The aggregated number of uncached audio input tokens used.
                   input_audio_tokens: nil,
 
-                  # The aggregated number of input tokens written to the cache.
+                  # The aggregated number of input tokens written to the cache with a 12-hour
+                  # retention period.
+                  input_cache_write_12h_tokens: nil,
+
+                  # The aggregated number of input tokens written to the cache with a 30-minute
+                  # retention period.
                   input_cache_write_tokens: nil,
 
                   # The aggregated number of cached audio input tokens used.
@@ -448,6 +464,7 @@ module OpenAI
                       api_key_id: T.nilable(String),
                       batch: T.nilable(T::Boolean),
                       input_audio_tokens: Integer,
+                      input_cache_write_12h_tokens: Integer,
                       input_cache_write_tokens: Integer,
                       input_cached_audio_tokens: Integer,
                       input_cached_image_tokens: Integer,

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

@@ -208,7 +208,16 @@ module OpenAI
                 sig { params(input_audio_tokens: Integer).void }
                 attr_writer :input_audio_tokens
 
-                # The aggregated number of input tokens written to the cache.
+                # The aggregated number of input tokens written to the cache with a 12-hour
+                # retention period.
+                sig { returns(T.nilable(Integer)) }
+                attr_reader :input_cache_write_12h_tokens
+
+                sig { params(input_cache_write_12h_tokens: Integer).void }
+                attr_writer :input_cache_write_12h_tokens
+
+                # The aggregated number of input tokens written to the cache with a 30-minute
+                # retention period.
                 sig { returns(T.nilable(Integer)) }
                 attr_reader :input_cache_write_tokens
 
@@ -324,6 +333,8 @@ module OpenAI
 
                     input_audio_tokens: Integer,
 
+                    input_cache_write_12h_tokens: Integer,
+
                     input_cache_write_tokens: Integer,
 
                     input_cached_audio_tokens: Integer,
@@ -384,7 +395,12 @@ module OpenAI
                   # The aggregated number of uncached audio input tokens used.
                   input_audio_tokens: nil,
 
-                  # The aggregated number of input tokens written to the cache.
+                  # The aggregated number of input tokens written to the cache with a 12-hour
+                  # retention period.
+                  input_cache_write_12h_tokens: nil,
+
+                  # The aggregated number of input tokens written to the cache with a 30-minute
+                  # retention period.
                   input_cache_write_tokens: nil,
 
                   # The aggregated number of cached audio input tokens used.
@@ -450,6 +466,7 @@ module OpenAI
                       api_key_id: T.nilable(String),
                       batch: T.nilable(T::Boolean),
                       input_audio_tokens: Integer,
+                      input_cache_write_12h_tokens: Integer,
                       input_cache_write_tokens: Integer,
                       input_cached_audio_tokens: Integer,
                       input_cached_image_tokens: Integer,

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

@@ -202,7 +202,16 @@ module OpenAI
                 sig { params(input_audio_tokens: Integer).void }
                 attr_writer :input_audio_tokens
 
-                # The aggregated number of input tokens written to the cache.
+                # The aggregated number of input tokens written to the cache with a 12-hour
+                # retention period.
+                sig { returns(T.nilable(Integer)) }
+                attr_reader :input_cache_write_12h_tokens
+
+                sig { params(input_cache_write_12h_tokens: Integer).void }
+                attr_writer :input_cache_write_12h_tokens
+
+                # The aggregated number of input tokens written to the cache with a 30-minute
+                # retention period.
                 sig { returns(T.nilable(Integer)) }
                 attr_reader :input_cache_write_tokens
 
@@ -318,6 +327,8 @@ module OpenAI
 
                     input_audio_tokens: Integer,
 
+                    input_cache_write_12h_tokens: Integer,
+
                     input_cache_write_tokens: Integer,
 
                     input_cached_audio_tokens: Integer,
@@ -378,7 +389,12 @@ module OpenAI
                   # The aggregated number of uncached audio input tokens used.
                   input_audio_tokens: nil,
 
-                  # The aggregated number of input tokens written to the cache.
+                  # The aggregated number of input tokens written to the cache with a 12-hour
+                  # retention period.
+                  input_cache_write_12h_tokens: nil,
+
+                  # The aggregated number of input tokens written to the cache with a 30-minute
+                  # retention period.
                   input_cache_write_tokens: nil,
 
                   # The aggregated number of cached audio input tokens used.
@@ -444,6 +460,7 @@ module OpenAI
                       api_key_id: T.nilable(String),
                       batch: T.nilable(T::Boolean),
                       input_audio_tokens: Integer,
+                      input_cache_write_12h_tokens: Integer,
                       input_cache_write_tokens: Integer,
                       input_cached_audio_tokens: Integer,
                       input_cached_image_tokens: Integer,

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

@@ -206,7 +206,16 @@ module OpenAI
                 sig { params(input_audio_tokens: Integer).void }
                 attr_writer :input_audio_tokens
 
-                # The aggregated number of input tokens written to the cache.
+                # The aggregated number of input tokens written to the cache with a 12-hour
+                # retention period.
+                sig { returns(T.nilable(Integer)) }
+                attr_reader :input_cache_write_12h_tokens
+
+                sig { params(input_cache_write_12h_tokens: Integer).void }
+                attr_writer :input_cache_write_12h_tokens
+
+                # The aggregated number of input tokens written to the cache with a 30-minute
+                # retention period.
                 sig { returns(T.nilable(Integer)) }
                 attr_reader :input_cache_write_tokens
 
@@ -322,6 +331,8 @@ module OpenAI
 
                     input_audio_tokens: Integer,
 
+                    input_cache_write_12h_tokens: Integer,
+
                     input_cache_write_tokens: Integer,
 
                     input_cached_audio_tokens: Integer,
@@ -382,7 +393,12 @@ module OpenAI
                   # The aggregated number of uncached audio input tokens used.
                   input_audio_tokens: nil,
 
-                  # The aggregated number of input tokens written to the cache.
+                  # The aggregated number of input tokens written to the cache with a 12-hour
+                  # retention period.
+                  input_cache_write_12h_tokens: nil,
+
+                  # The aggregated number of input tokens written to the cache with a 30-minute
+                  # retention period.
                   input_cache_write_tokens: nil,
 
                   # The aggregated number of cached audio input tokens used.
@@ -448,6 +464,7 @@ module OpenAI
                       api_key_id: T.nilable(String),
                       batch: T.nilable(T::Boolean),
                       input_audio_tokens: Integer,
+                      input_cache_write_12h_tokens: Integer,
                       input_cache_write_tokens: Integer,
                       input_cached_audio_tokens: Integer,
                       input_cached_image_tokens: Integer,

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

@@ -206,7 +206,16 @@ module OpenAI
                 sig { params(input_audio_tokens: Integer).void }
                 attr_writer :input_audio_tokens
 
-                # The aggregated number of input tokens written to the cache.
+                # The aggregated number of input tokens written to the cache with a 12-hour
+                # retention period.
+                sig { returns(T.nilable(Integer)) }
+                attr_reader :input_cache_write_12h_tokens
+
+                sig { params(input_cache_write_12h_tokens: Integer).void }
+                attr_writer :input_cache_write_12h_tokens
+
+                # The aggregated number of input tokens written to the cache with a 30-minute
+                # retention period.
                 sig { returns(T.nilable(Integer)) }
                 attr_reader :input_cache_write_tokens
 
@@ -322,6 +331,8 @@ module OpenAI
 
                     input_audio_tokens: Integer,
 
+                    input_cache_write_12h_tokens: Integer,
+
                     input_cache_write_tokens: Integer,
 
                     input_cached_audio_tokens: Integer,
@@ -382,7 +393,12 @@ module OpenAI
                   # The aggregated number of uncached audio input tokens used.
                   input_audio_tokens: nil,
 
-                  # The aggregated number of input tokens written to the cache.
+                  # The aggregated number of input tokens written to the cache with a 12-hour
+                  # retention period.
+                  input_cache_write_12h_tokens: nil,
+
+                  # The aggregated number of input tokens written to the cache with a 30-minute
+                  # retention period.
                   input_cache_write_tokens: nil,
 
                   # The aggregated number of cached audio input tokens used.
@@ -448,6 +464,7 @@ module OpenAI
                       api_key_id: T.nilable(String),
                       batch: T.nilable(T::Boolean),
                       input_audio_tokens: Integer,
+                      input_cache_write_12h_tokens: Integer,
                       input_cache_write_tokens: Integer,
                       input_cached_audio_tokens: Integer,
                       input_cached_image_tokens: Integer,

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

@@ -208,7 +208,16 @@ module OpenAI
                 sig { params(input_audio_tokens: Integer).void }
                 attr_writer :input_audio_tokens
 
-                # The aggregated number of input tokens written to the cache.
+                # The aggregated number of input tokens written to the cache with a 12-hour
+                # retention period.
+                sig { returns(T.nilable(Integer)) }
+                attr_reader :input_cache_write_12h_tokens
+
+                sig { params(input_cache_write_12h_tokens: Integer).void }
+                attr_writer :input_cache_write_12h_tokens
+
+                # The aggregated number of input tokens written to the cache with a 30-minute
+                # retention period.
                 sig { returns(T.nilable(Integer)) }
                 attr_reader :input_cache_write_tokens
 
@@ -324,6 +333,8 @@ module OpenAI
 
                     input_audio_tokens: Integer,
 
+                    input_cache_write_12h_tokens: Integer,
+
                     input_cache_write_tokens: Integer,
 
                     input_cached_audio_tokens: Integer,
@@ -384,7 +395,12 @@ module OpenAI
                   # The aggregated number of uncached audio input tokens used.
                   input_audio_tokens: nil,
 
-                  # The aggregated number of input tokens written to the cache.
+                  # The aggregated number of input tokens written to the cache with a 12-hour
+                  # retention period.
+                  input_cache_write_12h_tokens: nil,
+
+                  # The aggregated number of input tokens written to the cache with a 30-minute
+                  # retention period.
                   input_cache_write_tokens: nil,
 
                   # The aggregated number of cached audio input tokens used.
@@ -450,6 +466,7 @@ module OpenAI
                       api_key_id: T.nilable(String),
                       batch: T.nilable(T::Boolean),
                       input_audio_tokens: Integer,
+                      input_cache_write_12h_tokens: Integer,
                       input_cache_write_tokens: Integer,
                       input_cached_audio_tokens: Integer,
                       input_cached_image_tokens: Integer,

data/rbi/openai/models/audio/speech_create_params.rbi

@@ -33,6 +33,8 @@ module OpenAI
         # object with an `id`, for example `{ "id": "voice_1234" }`. Previews of the
         # voices are available in the
         # [Text to speech guide](https://developers.openai.com/api/docs/guides/text-to-speech#voice-options).
+        # Custom voices must be created from audio samples. Voices created from text
+        # prompts are supported only in Live.
         sig {
           returns(
             T.any(
@@ -117,6 +119,8 @@ module OpenAI
           # object with an `id`, for example `{ "id": "voice_1234" }`. Previews of the
           # voices are available in the
           # [Text to speech guide](https://developers.openai.com/api/docs/guides/text-to-speech#voice-options).
+          # Custom voices must be created from audio samples. Voices created from text
+          # prompts are supported only in Live.
           voice:,
 
           # Control the voice of your generated audio with additional instructions. Does not
@@ -180,6 +184,8 @@ module OpenAI
         # object with an `id`, for example `{ "id": "voice_1234" }`. Previews of the
         # voices are available in the
         # [Text to speech guide](https://developers.openai.com/api/docs/guides/text-to-speech#voice-options).
+        # Custom voices must be created from audio samples. Voices created from text
+        # prompts are supported only in Live.
         module Voice
           extend OpenAI::Internal::Type::Union
 

data/rbi/openai/models/audio/voice.rbi

@@ -0,0 +1,111 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Audio
+
+      class Voice < OpenAI::Internal::Type::BaseModel
+
+        OrHash = T.type_alias do
+          T.any(
+            OpenAI::Audio::Voice,
+            OpenAI::Internal::AnyHash
+          )
+        end
+
+        # The voice identifier, which can be referenced in API endpoints.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The Unix timestamp (in seconds) for when the voice was created.
+        sig { returns(Integer) }
+        attr_accessor :created_at
+
+        # The name of the voice.
+        sig { returns(String) }
+        attr_accessor :name
+
+        # The object type, which is always `audio.voice`.
+        sig { returns(Symbol) }
+        attr_accessor :object
+
+        # How the voice was created. Voices created from text prompts are supported only
+        # in Live.
+        sig { returns(OpenAI::Audio::Voice::Type::TaggedSymbol) }
+        attr_accessor :type
+
+        # A custom voice that can be used for audio output. Voices created from text
+        # prompts are supported only in Live.
+        sig do
+          params(
+
+            id: String,
+
+            created_at: Integer,
+
+            name: String,
+
+            type: OpenAI::Audio::Voice::Type::OrSymbol,
+
+            object: Symbol
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+
+          # The voice identifier, which can be referenced in API endpoints.
+          id:,
+
+          # The Unix timestamp (in seconds) for when the voice was created.
+          created_at:,
+
+          # The name of the voice.
+          name:,
+
+          # How the voice was created. Voices created from text prompts are supported only
+          # in Live.
+          type:,
+
+          # The object type, which is always `audio.voice`.
+
+          object: :"audio.voice"
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              created_at: Integer,
+              name: String,
+              object: Symbol,
+              type: OpenAI::Audio::Voice::Type::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # How the voice was created. Voices created from text prompts are supported only
+        # in Live.
+        module Type
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::Audio::Voice::Type) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          AUDIO_SAMPLE = T.let(:audio_sample, OpenAI::Audio::Voice::Type::TaggedSymbol)
+          PROMPT = T.let(:prompt, OpenAI::Audio::Voice::Type::TaggedSymbol)
+
+          sig { override.returns(T::Array[OpenAI::Audio::Voice::Type::TaggedSymbol]) }
+          def self.values
+          end
+        end
+
+      end
+
+    end
+
+  end
+end