openai 0.97.0 → 0.99.0

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

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

@@ -0,0 +1,203 @@
+module OpenAI
+  module Models
+    module Audio
+      type voice_create_params =
+        {
+          body: OpenAI::Models::Audio::VoiceCreateParams::body,
+          ?request_options: OpenAI::request_opts
+        }
+
+      class VoiceCreateParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        # Creates a voice from a consent recording and an audio sample. Requires
+        # multipart/form-data.
+        attr_accessor body: OpenAI::Models::Audio::VoiceCreateParams::body
+
+        # @param body
+        #   Creates a voice from a consent recording and an audio sample. Requires
+        #   multipart/form-data.
+        def initialize: (
+          body: OpenAI::Models::Audio::VoiceCreateParams::body,
+          ?request_options: OpenAI::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          body: OpenAI::Models::Audio::VoiceCreateParams::body,
+          ?request_options: OpenAI::RequestOptions
+        }
+
+        type body =
+          OpenAI::Audio::VoiceCreateParams::Body::AudioSample
+          | OpenAI::Audio::VoiceCreateParams::Body::Prompt
+
+        module Body
+          extend OpenAI::Internal::Type::Union
+
+          type audio_sample =
+            {
+              audio_sample: OpenAI::Internal::file_input,
+              consent: String,
+              name: String,
+              ?type: OpenAI::Models::Audio::VoiceCreateParams::Body::AudioSample::type_
+            }
+
+          class AudioSample < OpenAI::Internal::Type::BaseModel
+            # The sample audio recording file. Maximum size is 10 MiB.
+            #
+            # Supported MIME types: `audio/mpeg`, `audio/wav`, `audio/x-wav`, `audio/ogg`,
+            # `audio/aac`, `audio/flac`, `audio/webm`, `audio/mp4`.
+            #
+            # `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
+            # metadata. Use `OpenAI::FilePart` when you need to override the filename or
+            # content type.
+            attr_accessor audio_sample: OpenAI::Internal::file_input
+
+            # The consent recording ID (for example, `cons_1234`).
+            attr_accessor consent: String
+
+            # The name of the new voice.
+            attr_accessor name: String
+
+            # The voice creation method. Defaults to `audio_sample` when omitted.
+            attr_reader type: OpenAI::Models::Audio::VoiceCreateParams::Body::AudioSample::type_?
+
+            # The voice creation method. Defaults to `audio_sample` when omitted.
+            def type=: (
+              OpenAI::Models::Audio::VoiceCreateParams::Body::AudioSample::type_
+            ) -> OpenAI::Models::Audio::VoiceCreateParams::Body::AudioSample::type_
+
+            # @param audio_sample
+            #   The sample audio recording file. Maximum size is 10 MiB.
+            #
+            #   Supported MIME types: `audio/mpeg`, `audio/wav`, `audio/x-wav`, `audio/ogg`,
+            #   `audio/aac`, `audio/flac`, `audio/webm`, `audio/mp4`.
+            #
+            #   `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
+            #   metadata. Use `OpenAI::FilePart` when you need to override the filename or
+            #   content type.
+            # @param consent
+            #   The consent recording ID (for example, `cons_1234`).
+            # @param name
+            #   The name of the new voice.
+            # @param type
+            #   The voice creation method. Defaults to `audio_sample` when omitted.
+            def initialize: (
+              audio_sample: OpenAI::Internal::file_input,
+              consent: String,
+              name: String,
+              ?type: OpenAI::Models::Audio::VoiceCreateParams::Body::AudioSample::type_
+            ) -> void
+
+            def to_hash: -> {
+              audio_sample: OpenAI::Internal::file_input,
+              consent: String,
+              name: String,
+              ?type: OpenAI::Models::Audio::VoiceCreateParams::Body::AudioSample::type_
+            }
+
+            type type_ = :audio_sample
+
+            module Type
+              extend OpenAI::Internal::Type::Enum
+
+              AUDIO_SAMPLE: :audio_sample
+
+              def self?.values: -> ::Array[OpenAI::Models::Audio::VoiceCreateParams::Body::AudioSample::type_]
+            end
+          end
+
+          type prompt =
+            {
+              name: String,
+              prompt: String,
+              type: OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt::type_,
+              ?model: OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt::model,
+              ?script_hint: String
+            }
+
+          class Prompt < OpenAI::Internal::Type::BaseModel
+            # The name of the new voice.
+            attr_accessor name: String
+
+            # A description of the desired voice. Must not contain only whitespace.
+            attr_accessor prompt: String
+
+            # Set to `prompt` to create a voice from a text description.
+            attr_accessor type: OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt::type_
+
+            # The voice creation model to use. Defaults to `auto`.
+            attr_reader model: OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt::model?
+
+            # The voice creation model to use. Defaults to `auto`.
+            def model=: (
+              OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt::model
+            ) -> OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt::model
+
+            # Optional text for the voice to speak during creation. If omitted, a script is
+            # generated from the prompt. Must not be blank after trimming whitespace; scripts
+            # that are too short are rejected.
+            attr_reader script_hint: String?
+
+            # Optional text for the voice to speak during creation. If omitted, a script is
+            # generated from the prompt. Must not be blank after trimming whitespace; scripts
+            # that are too short are rejected.
+            def script_hint=: (String) -> String
+
+            # @param name
+            #   The name of the new voice.
+            # @param prompt
+            #   A description of the desired voice. Must not contain only whitespace.
+            # @param type
+            #   Set to `prompt` to create a voice from a text description.
+            # @param model
+            #   The voice creation model to use. Defaults to `auto`.
+            # @param script_hint
+            #   Optional text for the voice to speak during creation. If omitted, a script is
+            #   generated from the prompt. Must not be blank after trimming whitespace; scripts
+            #   that are too short are rejected.
+            def initialize: (
+              name: String,
+              prompt: String,
+              type: OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt::type_,
+              ?model: OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt::model,
+              ?script_hint: String
+            ) -> void
+
+            def to_hash: -> {
+              name: String,
+              prompt: String,
+              type: OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt::type_,
+              ?model: OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt::model,
+              ?script_hint: String
+            }
+
+            type type_ = :prompt
+
+            module Type
+              extend OpenAI::Internal::Type::Enum
+
+              PROMPT: :prompt
+
+              def self?.values: -> ::Array[OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt::type_]
+            end
+
+            type model = String | :auto | :"2026-10-01"
+
+            module Model
+              extend OpenAI::Internal::Type::Union
+
+              def self?.variants: -> ::Array[OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt::model]
+
+              AUTO: :auto
+              MODEL_2026_10_01: :"2026-10-01"
+            end
+          end
+
+          def self?.variants: -> ::Array[OpenAI::Models::Audio::VoiceCreateParams::body]
+        end
+      end
+    end
+  end
+end

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

@@ -98,8 +98,7 @@ module OpenAI
           ?request_options: OpenAI::RequestOptions
         }
 
-        type service_tier =
-          :auto | :default | :flex | :priority | :fast | :ultrafast
+        type service_tier = :auto | :default | :flex | :priority | :fast
 
         module ServiceTier
           extend OpenAI::Internal::Type::Enum
@@ -119,9 +118,6 @@ module OpenAI
           # Uses the fast service tier.
           FAST: :fast
 
-          # Uses the ultrafast service tier.
-          ULTRAFAST: :ultrafast
-
           def self?.values: -> ::Array[OpenAI::Models::Beta::AgentCreateParams::service_tier]
         end
       end

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

@@ -106,8 +106,7 @@ module OpenAI
           ?request_options: OpenAI::RequestOptions
         }
 
-        type service_tier =
-          :auto | :default | :flex | :priority | :fast | :ultrafast
+        type service_tier = :auto | :default | :flex | :priority | :fast
 
         module ServiceTier
           extend OpenAI::Internal::Type::Enum
@@ -127,9 +126,6 @@ module OpenAI
           # Uses the fast service tier.
           FAST: :fast
 
-          # Uses the ultrafast service tier.
-          ULTRAFAST: :ultrafast
-
           def self?.values: -> ::Array[OpenAI::Models::Beta::AgentUpdateParams::service_tier]
         end
       end

data/sig/openai/models/beta/agents/session_create_params.rbs

@@ -163,8 +163,7 @@ module OpenAI
               ?tools: ::Array[OpenAI::Models::Beta::agent_tool_param]?
             }
 
-            type service_tier =
-              :auto | :default | :flex | :priority | :fast | :ultrafast
+            type service_tier = :auto | :default | :flex | :priority | :fast
 
             module ServiceTier
               extend OpenAI::Internal::Type::Enum
@@ -184,9 +183,6 @@ module OpenAI
               # Uses the fast service tier.
               FAST: :fast
 
-              # Uses the ultrafast service tier.
-              ULTRAFAST: :ultrafast
-
               def self?.values: -> ::Array[OpenAI::Models::Beta::Agents::SessionCreateParams::Agent::service_tier]
             end
           end

data/sig/openai/models/beta/agents/session_update_params.rbs

@@ -129,8 +129,7 @@ module OpenAI
               end
             end
 
-            type service_tier =
-              :auto | :default | :flex | :priority | :fast | :ultrafast
+            type service_tier = :auto | :default | :flex | :priority | :fast
 
             module ServiceTier
               extend OpenAI::Internal::Type::Enum
@@ -150,9 +149,6 @@ module OpenAI
               # Uses the fast service tier.
               FAST: :fast
 
-              # Uses the ultrafast service tier.
-              ULTRAFAST: :ultrafast
-
               def self?.values: -> ::Array[OpenAI::Models::Beta::Agents::SessionUpdateParams::Agent::service_tier]
             end
           end

data/sig/openai/models/beta/agents/sessions/session_trace.rbs

@@ -0,0 +1,65 @@
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        class SessionTrace = Sessions::SessionTrace
+
+        module Sessions
+          type session_trace =
+            {
+              id: String,
+              created_at: Integer,
+              ?object: :"agent.session.trace",
+              otlp: ::Hash[Symbol, top],
+              session_id: String
+            }
+
+          class SessionTrace < OpenAI::Internal::Type::BaseModel
+            # The root turn ID. Use this ID as the pagination anchor.
+            attr_accessor id: String
+
+            # The Unix timestamp in seconds when the root turn was created.
+            attr_accessor created_at: Integer
+
+            # The object type, which is always `agent.session.trace`.
+            attr_accessor object: :"agent.session.trace"
+
+            # An OTLP JSON ExportTraceServiceRequest containing resourceSpans. Only currently
+            # published data is returned; later trace updates are not awaited.
+            attr_accessor otlp: ::Hash[Symbol, top]
+
+            # The session that owns this trace.
+            attr_accessor session_id: String
+
+            # @param id
+            #   The root turn ID. Use this ID as the pagination anchor.
+            # @param created_at
+            #   The Unix timestamp in seconds when the root turn was created.
+            # @param otlp
+            #   An OTLP JSON ExportTraceServiceRequest containing resourceSpans. Only currently
+            #   published data is returned; later trace updates are not awaited.
+            # @param session_id
+            #   The session that owns this trace.
+            # @param object
+            #   The object type, which is always `agent.session.trace`.
+            def initialize: (
+              id: String,
+              created_at: Integer,
+              otlp: ::Hash[Symbol, top],
+              session_id: String,
+              ?object: :"agent.session.trace"
+            ) -> void
+
+            def to_hash: -> {
+              id: String,
+              created_at: Integer,
+              ?object: :"agent.session.trace",
+              otlp: ::Hash[Symbol, top],
+              session_id: String
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/sig/openai/models/beta/agents/sessions/trace_list_params.rbs

@@ -0,0 +1,81 @@
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        module Sessions
+          type trace_list_params =
+            {
+              session_id: String,
+              ?after: String,
+              ?limit: Integer,
+              ?order: OpenAI::Models::Beta::Agents::Sessions::TraceListParams::order,
+              ?request_options: OpenAI::request_opts
+            }
+
+          class TraceListParams < OpenAI::Internal::Type::BaseModel
+            extend OpenAI::Internal::Type::RequestParameters::Converter
+            include OpenAI::Internal::Type::RequestParameters
+
+            attr_accessor session_id: String
+
+            # Return resources after this resource ID in the selected order.
+            attr_reader after: String?
+
+            # Return resources after this resource ID in the selected order.
+            def after=: (String) -> String
+
+            # The maximum number of resources to return, between 1 and 100. Defaults to 20.
+            attr_reader limit: Integer?
+
+            # The maximum number of resources to return, between 1 and 100. Defaults to 20.
+            def limit=: (Integer) -> Integer
+
+            # The order in which resources are returned. Defaults to `desc`.
+            attr_reader order: OpenAI::Models::Beta::Agents::Sessions::TraceListParams::order?
+
+            # The order in which resources are returned. Defaults to `desc`.
+            def order=: (
+              OpenAI::Models::Beta::Agents::Sessions::TraceListParams::order
+            ) -> OpenAI::Models::Beta::Agents::Sessions::TraceListParams::order
+
+            # @param after
+            #   Return resources after this resource ID in the selected order.
+            # @param limit
+            #   The maximum number of resources to return, between 1 and 100. Defaults to 20.
+            # @param order
+            #   The order in which resources are returned. Defaults to `desc`.
+            def initialize: (
+              session_id: String,
+              ?after: String,
+              ?limit: Integer,
+              ?order: OpenAI::Models::Beta::Agents::Sessions::TraceListParams::order,
+              ?request_options: OpenAI::request_opts
+            ) -> void
+
+            def to_hash: -> {
+              session_id: String,
+              ?after: String,
+              ?limit: Integer,
+              ?order: OpenAI::Models::Beta::Agents::Sessions::TraceListParams::order,
+              ?request_options: OpenAI::RequestOptions
+            }
+
+            type order = :asc | :desc
+
+            module Order
+              extend OpenAI::Internal::Type::Enum
+
+              # Returns resources in ascending order.
+              ASC: :asc
+
+              # Returns resources in descending order.
+              DESC: :desc
+
+              def self?.values: -> ::Array[OpenAI::Models::Beta::Agents::Sessions::TraceListParams::order]
+            end
+          end
+        end
+      end
+    end
+  end
+end