openai 0.98.0 → 0.99.0

data/sig/openai/models/admin/organization/usage_costs_response.rbs

@@ -89,6 +89,7 @@ module OpenAI
                   ?api_key_id: String?,
                   ?batch: bool?,
                   ?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,
@@ -136,10 +137,20 @@ module OpenAI
                 # The aggregated number of uncached audio input tokens used.
                 def input_audio_tokens=: (Integer) -> Integer
 
-                # 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.
+                attr_reader input_cache_write_12h_tokens: Integer?
+
+                # The aggregated number of input tokens written to the cache with a 12-hour
+                # retention period.
+                def input_cache_write_12h_tokens=: (Integer) -> Integer
+
+                # The aggregated number of input tokens written to the cache with a 30-minute
+                # retention period.
                 attr_reader input_cache_write_tokens: Integer?
 
-                # The aggregated number of input tokens written to the cache.
+                # The aggregated number of input tokens written to the cache with a 30-minute
+                # retention period.
                 def input_cache_write_tokens=: (Integer) -> Integer
 
                 # The aggregated number of cached audio input tokens used.
@@ -242,8 +253,12 @@ module OpenAI
                 #   batch or not.
                 # @param input_audio_tokens
                 #   The aggregated number of uncached audio input tokens used.
+                # @param input_cache_write_12h_tokens
+                #   The aggregated number of input tokens written to the cache with a 12-hour
+                #   retention period.
                 # @param input_cache_write_tokens
-                #   The aggregated number of input tokens written to the cache.
+                #   The aggregated number of input tokens written to the cache with a 30-minute
+                #   retention period.
                 # @param input_cached_audio_tokens
                 #   The aggregated number of cached audio input tokens used.
                 # @param input_cached_image_tokens
@@ -286,6 +301,7 @@ module OpenAI
                   ?api_key_id: String?,
                   ?batch: bool?,
                   ?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,
@@ -312,6 +328,7 @@ module OpenAI
                   ?api_key_id: String?,
                   ?batch: bool?,
                   ?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/sig/openai/models/admin/organization/usage_embeddings_response.rbs

@@ -89,6 +89,7 @@ module OpenAI
                   ?api_key_id: String?,
                   ?batch: bool?,
                   ?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,
@@ -136,10 +137,20 @@ module OpenAI
                 # The aggregated number of uncached audio input tokens used.
                 def input_audio_tokens=: (Integer) -> Integer
 
-                # 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.
+                attr_reader input_cache_write_12h_tokens: Integer?
+
+                # The aggregated number of input tokens written to the cache with a 12-hour
+                # retention period.
+                def input_cache_write_12h_tokens=: (Integer) -> Integer
+
+                # The aggregated number of input tokens written to the cache with a 30-minute
+                # retention period.
                 attr_reader input_cache_write_tokens: Integer?
 
-                # The aggregated number of input tokens written to the cache.
+                # The aggregated number of input tokens written to the cache with a 30-minute
+                # retention period.
                 def input_cache_write_tokens=: (Integer) -> Integer
 
                 # The aggregated number of cached audio input tokens used.
@@ -242,8 +253,12 @@ module OpenAI
                 #   batch or not.
                 # @param input_audio_tokens
                 #   The aggregated number of uncached audio input tokens used.
+                # @param input_cache_write_12h_tokens
+                #   The aggregated number of input tokens written to the cache with a 12-hour
+                #   retention period.
                 # @param input_cache_write_tokens
-                #   The aggregated number of input tokens written to the cache.
+                #   The aggregated number of input tokens written to the cache with a 30-minute
+                #   retention period.
                 # @param input_cached_audio_tokens
                 #   The aggregated number of cached audio input tokens used.
                 # @param input_cached_image_tokens
@@ -286,6 +301,7 @@ module OpenAI
                   ?api_key_id: String?,
                   ?batch: bool?,
                   ?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,
@@ -312,6 +328,7 @@ module OpenAI
                   ?api_key_id: String?,
                   ?batch: bool?,
                   ?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/sig/openai/models/admin/organization/usage_file_search_calls_response.rbs

@@ -89,6 +89,7 @@ module OpenAI
                   ?api_key_id: String?,
                   ?batch: bool?,
                   ?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,
@@ -136,10 +137,20 @@ module OpenAI
                 # The aggregated number of uncached audio input tokens used.
                 def input_audio_tokens=: (Integer) -> Integer
 
-                # 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.
+                attr_reader input_cache_write_12h_tokens: Integer?
+
+                # The aggregated number of input tokens written to the cache with a 12-hour
+                # retention period.
+                def input_cache_write_12h_tokens=: (Integer) -> Integer
+
+                # The aggregated number of input tokens written to the cache with a 30-minute
+                # retention period.
                 attr_reader input_cache_write_tokens: Integer?
 
-                # The aggregated number of input tokens written to the cache.
+                # The aggregated number of input tokens written to the cache with a 30-minute
+                # retention period.
                 def input_cache_write_tokens=: (Integer) -> Integer
 
                 # The aggregated number of cached audio input tokens used.
@@ -242,8 +253,12 @@ module OpenAI
                 #   batch or not.
                 # @param input_audio_tokens
                 #   The aggregated number of uncached audio input tokens used.
+                # @param input_cache_write_12h_tokens
+                #   The aggregated number of input tokens written to the cache with a 12-hour
+                #   retention period.
                 # @param input_cache_write_tokens
-                #   The aggregated number of input tokens written to the cache.
+                #   The aggregated number of input tokens written to the cache with a 30-minute
+                #   retention period.
                 # @param input_cached_audio_tokens
                 #   The aggregated number of cached audio input tokens used.
                 # @param input_cached_image_tokens
@@ -286,6 +301,7 @@ module OpenAI
                   ?api_key_id: String?,
                   ?batch: bool?,
                   ?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,
@@ -312,6 +328,7 @@ module OpenAI
                   ?api_key_id: String?,
                   ?batch: bool?,
                   ?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/sig/openai/models/admin/organization/usage_images_response.rbs

@@ -89,6 +89,7 @@ module OpenAI
                   ?api_key_id: String?,
                   ?batch: bool?,
                   ?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,
@@ -136,10 +137,20 @@ module OpenAI
                 # The aggregated number of uncached audio input tokens used.
                 def input_audio_tokens=: (Integer) -> Integer
 
-                # 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.
+                attr_reader input_cache_write_12h_tokens: Integer?
+
+                # The aggregated number of input tokens written to the cache with a 12-hour
+                # retention period.
+                def input_cache_write_12h_tokens=: (Integer) -> Integer
+
+                # The aggregated number of input tokens written to the cache with a 30-minute
+                # retention period.
                 attr_reader input_cache_write_tokens: Integer?
 
-                # The aggregated number of input tokens written to the cache.
+                # The aggregated number of input tokens written to the cache with a 30-minute
+                # retention period.
                 def input_cache_write_tokens=: (Integer) -> Integer
 
                 # The aggregated number of cached audio input tokens used.
@@ -242,8 +253,12 @@ module OpenAI
                 #   batch or not.
                 # @param input_audio_tokens
                 #   The aggregated number of uncached audio input tokens used.
+                # @param input_cache_write_12h_tokens
+                #   The aggregated number of input tokens written to the cache with a 12-hour
+                #   retention period.
                 # @param input_cache_write_tokens
-                #   The aggregated number of input tokens written to the cache.
+                #   The aggregated number of input tokens written to the cache with a 30-minute
+                #   retention period.
                 # @param input_cached_audio_tokens
                 #   The aggregated number of cached audio input tokens used.
                 # @param input_cached_image_tokens
@@ -286,6 +301,7 @@ module OpenAI
                   ?api_key_id: String?,
                   ?batch: bool?,
                   ?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,
@@ -312,6 +328,7 @@ module OpenAI
                   ?api_key_id: String?,
                   ?batch: bool?,
                   ?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/sig/openai/models/admin/organization/usage_moderations_response.rbs

@@ -89,6 +89,7 @@ module OpenAI
                   ?api_key_id: String?,
                   ?batch: bool?,
                   ?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,
@@ -136,10 +137,20 @@ module OpenAI
                 # The aggregated number of uncached audio input tokens used.
                 def input_audio_tokens=: (Integer) -> Integer
 
-                # 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.
+                attr_reader input_cache_write_12h_tokens: Integer?
+
+                # The aggregated number of input tokens written to the cache with a 12-hour
+                # retention period.
+                def input_cache_write_12h_tokens=: (Integer) -> Integer
+
+                # The aggregated number of input tokens written to the cache with a 30-minute
+                # retention period.
                 attr_reader input_cache_write_tokens: Integer?
 
-                # The aggregated number of input tokens written to the cache.
+                # The aggregated number of input tokens written to the cache with a 30-minute
+                # retention period.
                 def input_cache_write_tokens=: (Integer) -> Integer
 
                 # The aggregated number of cached audio input tokens used.
@@ -242,8 +253,12 @@ module OpenAI
                 #   batch or not.
                 # @param input_audio_tokens
                 #   The aggregated number of uncached audio input tokens used.
+                # @param input_cache_write_12h_tokens
+                #   The aggregated number of input tokens written to the cache with a 12-hour
+                #   retention period.
                 # @param input_cache_write_tokens
-                #   The aggregated number of input tokens written to the cache.
+                #   The aggregated number of input tokens written to the cache with a 30-minute
+                #   retention period.
                 # @param input_cached_audio_tokens
                 #   The aggregated number of cached audio input tokens used.
                 # @param input_cached_image_tokens
@@ -286,6 +301,7 @@ module OpenAI
                   ?api_key_id: String?,
                   ?batch: bool?,
                   ?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,
@@ -312,6 +328,7 @@ module OpenAI
                   ?api_key_id: String?,
                   ?batch: bool?,
                   ?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/sig/openai/models/admin/organization/usage_vector_stores_response.rbs

@@ -89,6 +89,7 @@ module OpenAI
                   ?api_key_id: String?,
                   ?batch: bool?,
                   ?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,
@@ -136,10 +137,20 @@ module OpenAI
                 # The aggregated number of uncached audio input tokens used.
                 def input_audio_tokens=: (Integer) -> Integer
 
-                # 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.
+                attr_reader input_cache_write_12h_tokens: Integer?
+
+                # The aggregated number of input tokens written to the cache with a 12-hour
+                # retention period.
+                def input_cache_write_12h_tokens=: (Integer) -> Integer
+
+                # The aggregated number of input tokens written to the cache with a 30-minute
+                # retention period.
                 attr_reader input_cache_write_tokens: Integer?
 
-                # The aggregated number of input tokens written to the cache.
+                # The aggregated number of input tokens written to the cache with a 30-minute
+                # retention period.
                 def input_cache_write_tokens=: (Integer) -> Integer
 
                 # The aggregated number of cached audio input tokens used.
@@ -242,8 +253,12 @@ module OpenAI
                 #   batch or not.
                 # @param input_audio_tokens
                 #   The aggregated number of uncached audio input tokens used.
+                # @param input_cache_write_12h_tokens
+                #   The aggregated number of input tokens written to the cache with a 12-hour
+                #   retention period.
                 # @param input_cache_write_tokens
-                #   The aggregated number of input tokens written to the cache.
+                #   The aggregated number of input tokens written to the cache with a 30-minute
+                #   retention period.
                 # @param input_cached_audio_tokens
                 #   The aggregated number of cached audio input tokens used.
                 # @param input_cached_image_tokens
@@ -286,6 +301,7 @@ module OpenAI
                   ?api_key_id: String?,
                   ?batch: bool?,
                   ?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,
@@ -312,6 +328,7 @@ module OpenAI
                   ?api_key_id: String?,
                   ?batch: bool?,
                   ?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/sig/openai/models/admin/organization/usage_web_search_calls_response.rbs

@@ -89,6 +89,7 @@ module OpenAI
                   ?api_key_id: String?,
                   ?batch: bool?,
                   ?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,
@@ -136,10 +137,20 @@ module OpenAI
                 # The aggregated number of uncached audio input tokens used.
                 def input_audio_tokens=: (Integer) -> Integer
 
-                # 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.
+                attr_reader input_cache_write_12h_tokens: Integer?
+
+                # The aggregated number of input tokens written to the cache with a 12-hour
+                # retention period.
+                def input_cache_write_12h_tokens=: (Integer) -> Integer
+
+                # The aggregated number of input tokens written to the cache with a 30-minute
+                # retention period.
                 attr_reader input_cache_write_tokens: Integer?
 
-                # The aggregated number of input tokens written to the cache.
+                # The aggregated number of input tokens written to the cache with a 30-minute
+                # retention period.
                 def input_cache_write_tokens=: (Integer) -> Integer
 
                 # The aggregated number of cached audio input tokens used.
@@ -242,8 +253,12 @@ module OpenAI
                 #   batch or not.
                 # @param input_audio_tokens
                 #   The aggregated number of uncached audio input tokens used.
+                # @param input_cache_write_12h_tokens
+                #   The aggregated number of input tokens written to the cache with a 12-hour
+                #   retention period.
                 # @param input_cache_write_tokens
-                #   The aggregated number of input tokens written to the cache.
+                #   The aggregated number of input tokens written to the cache with a 30-minute
+                #   retention period.
                 # @param input_cached_audio_tokens
                 #   The aggregated number of cached audio input tokens used.
                 # @param input_cached_image_tokens
@@ -286,6 +301,7 @@ module OpenAI
                   ?api_key_id: String?,
                   ?batch: bool?,
                   ?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,
@@ -312,6 +328,7 @@ module OpenAI
                   ?api_key_id: String?,
                   ?batch: bool?,
                   ?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/sig/openai/models/audio/speech_create_params.rbs

@@ -31,6 +31,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.
         attr_accessor voice: OpenAI::Models::Audio::SpeechCreateParams::voice
 
         # Control the voice of your generated audio with additional instructions. Does not
@@ -82,6 +84,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.
         # @param instructions
         #   Control the voice of your generated audio with additional instructions. Does not
         #   work with `tts-1` or `tts-1-hd`.

data/sig/openai/models/audio/voice.rbs

@@ -0,0 +1,70 @@
+module OpenAI
+  module Models
+    module Audio
+      type voice =
+        {
+          id: String,
+          created_at: Integer,
+          name: String,
+          ?object: :"audio.voice",
+          type: OpenAI::Models::Audio::Voice::type_
+        }
+
+      class Voice < OpenAI::Internal::Type::BaseModel
+        # The voice identifier, which can be referenced in API endpoints.
+        attr_accessor id: String
+
+        # The Unix timestamp (in seconds) for when the voice was created.
+        attr_accessor created_at: Integer
+
+        # The name of the voice.
+        attr_accessor name: String
+
+        # The object type, which is always `audio.voice`.
+        attr_accessor object: :"audio.voice"
+
+        # How the voice was created. Voices created from text prompts are supported only
+        # in Live.
+        attr_accessor type: OpenAI::Models::Audio::Voice::type_
+
+        # @param id
+        #   The voice identifier, which can be referenced in API endpoints.
+        # @param created_at
+        #   The Unix timestamp (in seconds) for when the voice was created.
+        # @param name
+        #   The name of the voice.
+        # @param type
+        #   How the voice was created. Voices created from text prompts are supported only
+        #   in Live.
+        # @param object
+        #   The object type, which is always `audio.voice`.
+        def initialize: (
+          id: String,
+          created_at: Integer,
+          name: String,
+          type: OpenAI::Models::Audio::Voice::type_,
+          ?object: :"audio.voice"
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          created_at: Integer,
+          name: String,
+          ?object: :"audio.voice",
+          type: OpenAI::Models::Audio::Voice::type_
+        }
+
+        type type_ = :audio_sample | :prompt
+
+        module Type
+          extend OpenAI::Internal::Type::Enum
+
+          AUDIO_SAMPLE: :audio_sample
+          PROMPT: :prompt
+
+          def self?.values: -> ::Array[OpenAI::Models::Audio::Voice::type_]
+        end
+      end
+    end
+  end
+end